diff --git a/README.md b/README.md index b2712a2..d01467a 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,45 @@ # terraform-aws-sso-assignment Terraform module which creates AWS SSO assignments on AWS. + + +## Requirements + +| Name | Version | +|------|---------| +| [terraform](#requirement\_terraform) | >= 0.13.7 | +| [aws](#requirement\_aws) | >= 3.24.0 | + +## Providers + +| Name | Version | +|------|---------| +| [aws](#provider\_aws) | 3.52.0 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [aws_ssoadmin_account_assignment.groups](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssoadmin_account_assignment) | resource | +| [aws_ssoadmin_account_assignment.users](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ssoadmin_account_assignment) | resource | +| [aws_identitystore_group.groups](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/identitystore_group) | data source | +| [aws_identitystore_user.users](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/identitystore_user) | data source | +| [aws_ssoadmin_permission_set.permission_sets](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssoadmin_permission_set) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [assignments](#input\_assignments) | Configuration variable for account assignments. | `map(map(map(list(string))))` | n/a | yes | +| [identity\_store\_id](#input\_identity\_store\_id) | The Identity Store ID associated with the Single Sign-On Instance. | `string` | n/a | yes | +| [instance\_arn](#input\_instance\_arn) | The Amazon Resource Name (ARN) of the SSO Instance under which the operation will be executed. | `string` | n/a | yes | +| [organization\_accounts](#input\_organization\_accounts) | List of information of accounts which belongs to AWS Organizations. |
list(object({
arn = string
email = string
id = string
name = string
}))
| n/a | yes | + +## Outputs + +No outputs. +