Skip to content

Commit

Permalink
Fix README Snippet Use of deployment_principal_arns (#172)
Browse files Browse the repository at this point in the history
* Fix use of `deployment_principal_arns` variable in README snippet.

* fix wording leading up to snippets in README.
  • Loading branch information
korenyoni authored Jun 28, 2021
1 parent 48ac13a commit f5169df
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ For a complete example, see [examples/complete](examples/complete).

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).

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

```hcl
Expand All @@ -115,13 +115,13 @@ module "cdn" {
parent_zone_name = "cloudposse.com"
deployment_principal_arns = {
"arn:aws:s3:::principal1" = ["prefix1/", "prefix2/"]
"arn:aws:s3:::principal2" = [""]
"arn:aws:iam::123456789012:role/principal1" = ["prefix1/", "prefix2/"]
"arn:aws:iam::123456789012:role/principal2" = [""]
}
}
```

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

```hcl
module "cdn" {
Expand Down
8 changes: 4 additions & 4 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ usage: |-
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).
This will create a new s3 bucket `eg-prod-app` for a cloudfront cdn, and allow `principal1` to upload to
The following will create a new s3 bucket `eg-prod-app` for a cloudfront cdn, and allow `principal1` to upload to
`prefix1` and `prefix2`, while allowing `principal2` to manage the whole bucket.
```hcl
Expand All @@ -80,13 +80,13 @@ usage: |-
parent_zone_name = "cloudposse.com"
deployment_principal_arns = {
"arn:aws:s3:::principal1" = ["prefix1/", "prefix2/"]
"arn:aws:s3:::principal2" = [""]
"arn:aws:iam::123456789012:role/principal1" = ["prefix1/", "prefix2/"]
"arn:aws:iam::123456789012:role/principal2" = [""]
}
}
```
This will reuse an existing s3 bucket `eg-prod-app` for a cloudfront cdn.
The following will reuse an existing s3 bucket `eg-prod-app` for a cloudfront cdn.
```hcl
module "cdn" {
Expand Down

0 comments on commit f5169df

Please sign in to comment.