add documentation

hashicorp · Dec 24, 2020 · 19c54b1 · 19c54b1
1 parent a0d28af
commit 19c54b1
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 4 deletions.
diff --git a/aws/resource_aws_ecrpublic_repository_policy_test.go b/aws/resource_aws_ecrpublic_repository_policy_test.go
@@ -97,11 +97,11 @@ func testAccCheckAwsEcrPublicRepositoryPolicyExists(name string) resource.TestCh
 func testAccAwsEcrPublicRepositoryPolicy(randString string) string {
 	return fmt.Sprintf(`
 resource "aws_ecrpublic_repository" "foo" {
-  name = "tf-acc-test-ecr-%s"
+  repository_name = "tf-acc-test-ecr-%s"
 }
 
 resource "aws_ecrpublic_repository_policy" "default" {
-  repository = aws_ecrpublic_repository.foo.name
+  repository = aws_ecrpublic_repository.foo.repository_name
 
   policy = <<EOF
 {
@@ -129,7 +129,7 @@ EOF
 func testAccAwsEcrPublicRepositoryPolicyWithIAMRole(randString string) string {
 	return fmt.Sprintf(`
 resource "aws_ecrpublic_repository" "foo" {
-  name = "tf-acc-test-ecr-%s"
+  repository_name = "tf-acc-test-ecr-%s"
 }
 
 resource "aws_iam_role" "foo" {
@@ -152,7 +152,7 @@ EOF
 }
 
 resource "aws_ecrpublic_repository_policy" "default" {
-  repository = aws_ecrpublic_repository.foo.name
+  repository = aws_ecrpublic_repository.foo.repository_name
 
   policy = <<EOF
 {

diff --git a/website/docs/r/ecrpublic_repository_policy.html.markdown b/website/docs/r/ecrpublic_repository_policy.html.markdown
@@ -0,0 +1,76 @@
+---
+subcategory: "ECR"
+layout: "aws"
+page_title: "AWS: aws_ecrpublic_repository_policy"
+description: |-
+  Provides an Elastic Container Registry Public Repository Policy.
+---
+
+# Resource: aws_ecrpublic_repository_policy
+
+Provides an Elastic Container Registry Public Repository Policy.
+
+Note that currently only one policy may be applied to a repository.
+
+## Example Usage
+
+```hcl
+resource "aws_ecrpublic_repository" "foo" {
+  repository_name = "bar"
+}
+
+resource "aws_ecr_repository_policy" "foopolicy" {
+  repository = aws_ecrpublic_repository.foo.repository_name
+
+  policy = <<EOF
+{
+    "Version": "2008-10-17",
+    "Statement": [
+        {
+            "Sid": "new policy",
+            "Effect": "Allow",
+            "Principal": "*",
+            "Action": [
+                "ecr:GetDownloadUrlForLayer",
+                "ecr:BatchGetImage",
+                "ecr:BatchCheckLayerAvailability",
+                "ecr:PutImage",
+                "ecr:InitiateLayerUpload",
+                "ecr:UploadLayerPart",
+                "ecr:CompleteLayerUpload",
+                "ecr:DescribeRepositories",
+                "ecr:GetRepositoryPolicy",
+                "ecr:ListImages",
+                "ecr:DeleteRepository",
+                "ecr:BatchDeleteImage",
+                "ecr:SetRepositoryPolicy",
+                "ecr:DeleteRepositoryPolicy"
+            ]
+        }
+    ]
+}
+EOF
+}
+```
+
+## Argument Reference
+
+The following arguments are supported:
+
+* `repository` - (Required) Name of the repository to apply the policy.
+* `policy` - (Required) The policy document. This is a JSON formatted string. For more information about building IAM policy documents with Terraform, see the [AWS IAM Policy Document Guide](https://learn.hashicorp.com/terraform/aws/iam-policy)
+
+## Attributes Reference
+
+In addition to all arguments above, the following attributes are exported:
+
+* `repository` - The name of the repository.
+* `registry_id` - The registry ID where the repository was created.
+
+## Import
+
+ECR Public Repository Policy can be imported using the repository name, e.g.
+
+```
+$ terraform import aws_ecrpublic_repository_policy.example example
+```