Skip to content

Commit a3a80d6

Browse files
committed
Update README
1 parent be3c07d commit a3a80d6

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

README.md

Lines changed: 65 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,70 @@
22

33
Terraform module which creates AWS SSO assignments on AWS.
44

5+
## Usage
6+
```hcl
7+
module "account_assignments" {
8+
source = "speee/sso_assignments/aws"
9+
10+
instance_arn = "arn:aws:sso:::instance/ssoins-9999999999999999"
11+
identity_store_id = "d-9999999999"
12+
13+
organization_accounts = [
14+
{
15+
arn = "arn:aws:organizations::123456789012:account/o-xxxxxxxxxx/123456789012"
16+
17+
id = "123456789012"
18+
name = "account1"
19+
},
20+
{
21+
arn = "arn:aws:organizations::123456789012:account/o-xxxxxxxxxx/234567890123"
22+
23+
id = "234567890123"
24+
name = "account2"
25+
},
26+
]
27+
28+
assignments = {
29+
"account1" = {
30+
"groups" = {
31+
"SystemAdministrator" = [
32+
"AdministratorAccess",
33+
],
34+
"Engineer" = [
35+
"PowerUserAccess",
36+
],
37+
"Manager" = [
38+
"ReadOnlyAccess",
39+
],
40+
},
41+
"users" = {
42+
43+
"AdministratorAccess",
44+
],
45+
},
46+
},
47+
"account2" = {
48+
"users" = {
49+
50+
"AdministratorAccess",
51+
],
52+
53+
"ReadOnlyAccess",
54+
],
55+
},
56+
},
57+
}
58+
}
59+
```
60+
61+
## Examples
62+
- [All account assignments in a single module](https://github.com/speee/terraform-aws-sso-assignment/tree/master/examples/all-in-one)
63+
- [Account assignments per organization units](https://github.com/speee/terraform-aws-sso-assignment/tree/master/examples/module-per-organizations-unit)
64+
65+
## Notes
66+
1. This module does not create no resource other than `aws_ssoadmin_account_assignment` resource. Use resources or data sources directly to manage other resources like `aws_ssoadmin_permission_set`.
67+
68+
569
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
670
## Requirements
771

@@ -14,7 +78,7 @@ Terraform module which creates AWS SSO assignments on AWS.
1478

1579
| Name | Version |
1680
|------|---------|
17-
| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.52.0 |
81+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.24.0 |
1882

1983
## Modules
2084

0 commit comments

Comments
 (0)