Skip to content

Commit c3dbf4e

Browse files
committed
docs(example/create-sso-groups): adds readme file
1 parent 1cda1e8 commit c3dbf4e

File tree

1 file changed

+35
-0
lines changed
  • examples/create-sso-group-and-assign-users

1 file changed

+35
-0
lines changed
Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
| Name | Version |
5+
|------|---------|
6+
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.8.4 |
7+
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.51.0 |
8+
9+
## Providers
10+
11+
| Name | Version |
12+
|------|---------|
13+
| <a name="provider_aws"></a> [aws](#provider\_aws) | 5.56.1 |
14+
15+
## Modules
16+
17+
| Name | Source | Version |
18+
|------|--------|---------|
19+
| <a name="module_sso_groups"></a> [sso\_groups](#module\_sso\_groups) | ../../modules/sso_groups/ | n/a |
20+
21+
## Resources
22+
23+
No resources.
24+
25+
## Inputs
26+
27+
| Name | Description | Type | Default | Required |
28+
|------|-------------|------|---------|:--------:|
29+
| <a name="input_sso_groups"></a> [sso\_groups](#input\_sso\_groups) | (Recquired)A map of objects defining AWS SSO groups to be created. Each object contains:<br> - group\_name: The name of the SSO group.<br> - group\_description: A description for the SSO group. | <pre>map(object(<br> {<br> group_name = string<br> group_description = string<br> }<br> ))</pre> | <pre>{<br> "Org_Staging_Dev": {<br> "group_description": "Developer access to org staging account",<br> "group_name": "Org_Staging_Dev"<br> }<br>}</pre> | no |
30+
| <a name="input_user_groups_map"></a> [user\_groups\_map](#input\_user\_groups\_map) | (Optional)Mapping of users to their respective sso groups within the Organisation. For example map of `user=[sso_groups]` | `map(list(string))` | <pre>{<br> "employee@org.com": [<br> "Org_Staging_Dev"<br> ]<br>}</pre> | no |
31+
32+
## Outputs
33+
34+
No outputs.
35+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)