Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
rakiyoshi committed Aug 4, 2021
1 parent be3c07d commit a3a80d6
Showing 1 changed file with 65 additions and 1 deletion.
66 changes: 65 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,70 @@

Terraform module which creates AWS SSO assignments on AWS.

## Usage
```hcl
module "account_assignments" {
source = "speee/sso_assignments/aws"
instance_arn = "arn:aws:sso:::instance/ssoins-9999999999999999"
identity_store_id = "d-9999999999"
organization_accounts = [
{
arn = "arn:aws:organizations::123456789012:account/o-xxxxxxxxxx/123456789012"
email = "[email protected]"
id = "123456789012"
name = "account1"
},
{
arn = "arn:aws:organizations::123456789012:account/o-xxxxxxxxxx/234567890123"
email = "[email protected]"
id = "234567890123"
name = "account2"
},
]
assignments = {
"account1" = {
"groups" = {
"SystemAdministrator" = [
"AdministratorAccess",
],
"Engineer" = [
"PowerUserAccess",
],
"Manager" = [
"ReadOnlyAccess",
],
},
"users" = {
"[email protected]" = [
"AdministratorAccess",
],
},
},
"account2" = {
"users" = {
"[email protected]" = [
"AdministratorAccess",
],
"[email protected]" = [
"ReadOnlyAccess",
],
},
},
}
}
```

## Examples
- [All account assignments in a single module](https://github.com/speee/terraform-aws-sso-assignment/tree/master/examples/all-in-one)
- [Account assignments per organization units](https://github.com/speee/terraform-aws-sso-assignment/tree/master/examples/module-per-organizations-unit)

## Notes
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`.


<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
## Requirements

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

| Name | Version |
|------|---------|
| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.52.0 |
| <a name="provider_aws"></a> [aws](#provider\_aws) | 3.24.0 |

## Modules

Expand Down

0 comments on commit a3a80d6

Please sign in to comment.