Skip to content

Commit f859d0c

Browse files
authored
Merge pull request #59 from aws-ia/novekm/update-docs
fix create apps example syntax highlighting
2 parents 067084a + f212990 commit f859d0c

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

.header.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,9 @@
1717

1818
- Locals are used to allow for global changes to multiple account assignments. If hard coding the account ids for your account assignments, you would need to change them in every place you want to reference the value. To simplify this, we recommend storing your desired account ids in [local values](https://developer.hashicorp.com/terraform/language/values/locals). See the `examples` directory for more information and sample code.
1919
- When using **Customer Managed Policies** with account assignments, you must ensure these policies exist in all target accounts **before** using the module. Failure to do this will cause deployment errors because IAM Identity Center will attempt to reference policies that do not exist.
20-
- **Ensure that the name of your object(s) match the name of your principal(s) (e.g. user name or group name). See the following example with object/principal names 'Admin' and 'nuzumaki'**:
20+
- The names of your object(s) (e.g. the groups or users you wish to create or reference) are used to reference them elsewhere within the module, such as referencing groups you wish to add users to, or permission sets you wish to use with your account assignments. While the names of these objects can be anything since they are just local references to the each object, ensure you reference the string exactly (case-sensitive) when using elsewhere in the module.
21+
- However, for the actual names of the existing groups, users, etc. **these must match exactly as they appear in your AWS IAM Identity Center configuration**. This is because for these resources, a data source is being used to fetch information about the existing resource using a filter on the name.
22+
- To simplify this and prevent confusion, we recommend using the same name for the object as the resource itself. See the following for an example:
2123

2224
```hcl
2325
sso_groups = {
@@ -196,7 +198,7 @@ module "aws-iam-identity-center" {
196198

197199
## Basic Usage - Create Applications and assign to Users and Groups
198200

199-
```
201+
```hcl
200202
// Create desired Applications in IAM Identity Center
201203
sso_applications = {
202204
FirstApplication : {

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818

1919
- Locals are used to allow for global changes to multiple account assignments. If hard coding the account ids for your account assignments, you would need to change them in every place you want to reference the value. To simplify this, we recommend storing your desired account ids in [local values](https://developer.hashicorp.com/terraform/language/values/locals). See the `examples` directory for more information and sample code.
2020
- When using **Customer Managed Policies** with account assignments, you must ensure these policies exist in all target accounts **before** using the module. Failure to do this will cause deployment errors because IAM Identity Center will attempt to reference policies that do not exist.
21-
- **Ensure that the name of your object(s) match the name of your principal(s) (e.g. user name or group name). See the following example with object/principal names 'Admin' and 'nuzumaki'**:
21+
- The names of your object(s) (e.g. the groups or users you wish to create or reference) are used to reference them elsewhere within the module, such as referencing groups you wish to add users to, or permission sets you wish to use with your account assignments. While the names of these objects can be anything since they are just local references to the each object, ensure you reference the string exactly (case-sensitive) when using elsewhere in the module.
22+
- However, for the actual names of the existing groups, users, etc. **these must match exactly as they appear in your AWS IAM Identity Center configuration**. This is because for these resources, a data source is being used to fetch information about the existing resource using a filter on the name.
23+
- To simplify this and prevent confusion, we recommend using the same name for the object as the resource itself. See the following for an example:
2224

2325
```hcl
2426
sso_groups = {
@@ -197,7 +199,7 @@ module "aws-iam-identity-center" {
197199

198200
## Basic Usage - Create Applications and assign to Users and Groups
199201

200-
```
202+
```hcl
201203
// Create desired Applications in IAM Identity Center
202204
sso_applications = {
203205
FirstApplication : {

0 commit comments

Comments
 (0)