Skip to content

Commit

Permalink
Update Readme (#46)
Browse files Browse the repository at this point in the history
* update readme

* update

* regenerate after make init

* reenerate
  • Loading branch information
Benbentwo authored May 14, 2024
1 parent 1fe2436 commit b687be8
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,12 @@ an object type declaration to use for the input and then it can make the transla
If you can supply the policy as JSON to begin with, or conveniently use the `aws_iam_policy_document`
Terraform data source directly, then this module is not helpful in your case.

NOTE: AWS's IAM policy document syntax allows for replacement of policy variables within a statement
using ${...}-style notation, which conflicts with Terraform's interpolation syntax. In order to use AWS
policy variables with this module, use &{...} notation for interpolations that should be processed
by AWS rather than by Terraform. Nevertheless, any ${...}-style notations that appear in strings passed into
this module (somehow escaping Terraform interpolation earlier) will be passed through to the policy document unchanged.
> [!NOTE]
> AWS's IAM policy document syntax allows for replacement of policy variables within a statement
> using `${...}`-style notation, which conflicts with Terraform's interpolation syntax. In order to use AWS
> policy variables with this module, use `&{...}` notation for interpolations that should be processed
> by AWS rather than by Terraform. Nevertheless, any `${...}`-style notations that appear in strings passed into
> this module (somehow escaping Terraform interpolation earlier) will be passed through to the policy document unchanged.

> [!TIP]
Expand Down
11 changes: 6 additions & 5 deletions README.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@ description: |-
If you can supply the policy as JSON to begin with, or conveniently use the `aws_iam_policy_document`
Terraform data source directly, then this module is not helpful in your case.
NOTE: AWS's IAM policy document syntax allows for replacement of policy variables within a statement
using ${...}-style notation, which conflicts with Terraform's interpolation syntax. In order to use AWS
policy variables with this module, use &{...} notation for interpolations that should be processed
by AWS rather than by Terraform. Nevertheless, any ${...}-style notations that appear in strings passed into
this module (somehow escaping Terraform interpolation earlier) will be passed through to the policy document unchanged.
> [!NOTE]
> AWS's IAM policy document syntax allows for replacement of policy variables within a statement
> using `${...}`-style notation, which conflicts with Terraform's interpolation syntax. In order to use AWS
> policy variables with this module, use `&{...}` notation for interpolations that should be processed
> by AWS rather than by Terraform. Nevertheless, any `${...}`-style notations that appear in strings passed into
> this module (somehow escaping Terraform interpolation earlier) will be passed through to the policy document unchanged.
# Introduction to the project
#introduction: |-
Expand Down

0 comments on commit b687be8

Please sign in to comment.