Skip to content

Commit 1cda1e8

Browse files
committed
docs(example/create-permission-set): adds readme file
1 parent 3a043ed commit 1cda1e8

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
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_permission_sets"></a> [permission\_sets](#module\_permission\_sets) | ../../modules/permission_sets | n/a |
20+
21+
## Resources
22+
23+
No resources.
24+
25+
## Inputs
26+
27+
| Name | Description | Type | Default | Required |
28+
|------|-------------|------|---------|:--------:|
29+
| <a name="input_permission_sets"></a> [permission\_sets](#input\_permission\_sets) | (Required)A map of permission set objects with key as the permission set name. Each object contains:<br> - name: The name of the permission set.<br> - description: A brief description of the permission set.<br> - session\_duration: Optional session duration for the permission set (default is null).<br> - relay\_state: Optional relay state for the permission set (default is null).<br> - tags: Optional map of tags to associate with the permission set.<br> - inline\_policy: The inline policy content in JSON format.<br> - managed\_policies: A list of ARNs of managed policies to attach to the permission set.<br> - customer\_managed\_policies: A list of customer-managed policies to attach to the permission set. Each policy includes:<br> - name: The name of the customer-managed policy.<br> - path: The path of the customer-managed policy (default is "/"). | <pre>map(object({<br> name = string<br> description = string<br> session_duration = optional(string, null)<br> relay_state = optional(string, null)<br> tags = optional(map(string))<br> inline_policy = string<br> managed_policies = list(string)<br> customer_managed_policies = list(object({<br> name = string<br> path = optional(string, "/")<br> }))<br> }))</pre> | <pre>{<br> "AdministratorAccess": {<br> "customer_managed_policies": [],<br> "description": "Allow Full Access to the account",<br> "inline_policy": "",<br> "managed_policies": [<br> "arn:aws:iam::aws:policy/AdministratorAccess"<br> ],<br> "name": "AdministratorAccess",<br> "relay_state": "",<br> "session_duration": "PT12H",<br> "tags": {}<br> }<br>}</pre> | no |
30+
31+
## Outputs
32+
33+
No outputs.
34+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)