Skip to content

Commit f5169df

Browse files
authored
Fix README Snippet Use of deployment_principal_arns (#172)
* Fix use of `deployment_principal_arns` variable in README snippet. * fix wording leading up to snippets in README.
1 parent 48ac13a commit f5169df

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ For a complete example, see [examples/complete](examples/complete).
9898

9999
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
100100

101-
This will create a new s3 bucket `eg-prod-app` for a cloudfront cdn, and allow `principal1` to upload to
101+
The following will create a new s3 bucket `eg-prod-app` for a cloudfront cdn, and allow `principal1` to upload to
102102
`prefix1` and `prefix2`, while allowing `principal2` to manage the whole bucket.
103103

104104
```hcl
@@ -115,13 +115,13 @@ module "cdn" {
115115
parent_zone_name = "cloudposse.com"
116116
117117
deployment_principal_arns = {
118-
"arn:aws:s3:::principal1" = ["prefix1/", "prefix2/"]
119-
"arn:aws:s3:::principal2" = [""]
118+
"arn:aws:iam::123456789012:role/principal1" = ["prefix1/", "prefix2/"]
119+
"arn:aws:iam::123456789012:role/principal2" = [""]
120120
}
121121
}
122122
```
123123

124-
This will reuse an existing s3 bucket `eg-prod-app` for a cloudfront cdn.
124+
The following will reuse an existing s3 bucket `eg-prod-app` for a cloudfront cdn.
125125

126126
```hcl
127127
module "cdn" {

README.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ usage: |-
6363
6464
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).
6565
66-
This will create a new s3 bucket `eg-prod-app` for a cloudfront cdn, and allow `principal1` to upload to
66+
The following will create a new s3 bucket `eg-prod-app` for a cloudfront cdn, and allow `principal1` to upload to
6767
`prefix1` and `prefix2`, while allowing `principal2` to manage the whole bucket.
6868
6969
```hcl
@@ -80,13 +80,13 @@ usage: |-
8080
parent_zone_name = "cloudposse.com"
8181
8282
deployment_principal_arns = {
83-
"arn:aws:s3:::principal1" = ["prefix1/", "prefix2/"]
84-
"arn:aws:s3:::principal2" = [""]
83+
"arn:aws:iam::123456789012:role/principal1" = ["prefix1/", "prefix2/"]
84+
"arn:aws:iam::123456789012:role/principal2" = [""]
8585
}
8686
}
8787
```
8888
89-
This will reuse an existing s3 bucket `eg-prod-app` for a cloudfront cdn.
89+
The following will reuse an existing s3 bucket `eg-prod-app` for a cloudfront cdn.
9090
9191
```hcl
9292
module "cdn" {

0 commit comments

Comments
 (0)