Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix README #49

Merged
merged 1 commit into from
Nov 12, 2024
Merged

fix README #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ module "aws_dynamic_provider_credentials" {
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_dynamic_credentials_role_name_override"></a> [dynamic\_credentials\_role\_name\_override](#input\_dynamic\_credentials\_role\_name\_override) | The name of the IAM role to create. If not set, the name will be generated automatically. | `string` | `"terraform-cloud-dynamic-credentials"` | no |
| <a name="input_policies"></a> [policies](#input\_policies) | A list of custom policies to attach to the IAM role. By default the provider will be allowed to perform all actions on all ec2 resources. | <pre>set(object({<br> Effect = string<br> Action = set(string)<br> Resource = string<br> }))</pre> | `[]` | no |
| <a name="input_statements"></a> [statements](#input\_statements) | The list of statements to use for the trust relationship | <pre>set(object({<br> org_name = string<br> project_name = string<br> workspace = string<br> run_phase = optional(string, "*")<br> }))</pre> | n/a | yes |
| <a name="input_policies"></a> [policies](#input\_policies) | A list of custom policies to attach to the IAM role. By default the provider will be allowed to perform all actions on all ec2 resources. | <pre>set(object({<br/> Effect = string<br/> Action = set(string)<br/> Resource = string<br/> }))</pre> | `[]` | no |
| <a name="input_statements"></a> [statements](#input\_statements) | The list of statements to use for the trust relationship | <pre>set(object({<br/> org_name = string<br/> project_name = string<br/> workspace = string<br/> run_phase = optional(string, "*")<br/> }))</pre> | n/a | yes |
| <a name="input_tfc_aws_audience"></a> [tfc\_aws\_audience](#input\_tfc\_aws\_audience) | AWS audience | `string` | `"aws.workload.identity"` | no |
| <a name="input_tfc_hostname"></a> [tfc\_hostname](#input\_tfc\_hostname) | The hostname of the TFC or TFE instance you'd like to use with AWS | `string` | `"app.terraform.io"` | no |
| <a name="input_tfc_organization"></a> [tfc\_organization](#input\_tfc\_organization) | Name of the organization | `string` | n/a | yes |
Expand Down
4 changes: 2 additions & 2 deletions modules/iam_roles/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_aws_iam_custom_policies"></a> [aws\_iam\_custom\_policies](#input\_aws\_iam\_custom\_policies) | A list of custom policies to attach to the IAM role. By default the provider will be allowed to perform all actions on all ec2 resources. | <pre>list(object({<br> Effect = string<br> Action = list(string)<br> Resource = string<br> }))</pre> | <pre>[<br> {<br> "Action": [<br> "ec2:*"<br> ],<br> "Effect": "Allow",<br> "Resource": "*"<br> }<br>]</pre> | no |
| <a name="input_aws_iam_custom_policies"></a> [aws\_iam\_custom\_policies](#input\_aws\_iam\_custom\_policies) | A list of custom policies to attach to the IAM role. By default the provider will be allowed to perform all actions on all ec2 resources. | <pre>list(object({<br/> Effect = string<br/> Action = list(string)<br/> Resource = string<br/> }))</pre> | <pre>[<br/> {<br/> "Action": [<br/> "ec2:*"<br/> ],<br/> "Effect": "Allow",<br/> "Resource": "*"<br/> }<br/>]</pre> | no |
| <a name="input_aws_iam_role_name_override"></a> [aws\_iam\_role\_name\_override](#input\_aws\_iam\_role\_name\_override) | The name of the IAM role to create. If not set, the name will be generated automatically. | `string` | `"terraform-cloud-dynamic-credentials"` | no |
| <a name="input_statements"></a> [statements](#input\_statements) | The list of statements to use for the trust relationship | <pre>set(object({<br> org_name = string<br> project_name = string<br> workspace = string<br> run_phase = string<br> }))</pre> | n/a | yes |
| <a name="input_statements"></a> [statements](#input\_statements) | The list of statements to use for the trust relationship | <pre>set(object({<br/> org_name = string<br/> project_name = string<br/> workspace = string<br/> run_phase = string<br/> }))</pre> | n/a | yes |
| <a name="input_tfc_hostname"></a> [tfc\_hostname](#input\_tfc\_hostname) | The hostname of the TFC or TFE instance you'd like to use with AWS | `string` | `"app.terraform.io"` | no |
| <a name="input_tfc_oidc_provider_arn"></a> [tfc\_oidc\_provider\_arn](#input\_tfc\_oidc\_provider\_arn) | The ARN of the OIDC provider to use for TFC | `string` | n/a | yes |
| <a name="input_tfc_oidc_provider_client_id_list"></a> [tfc\_oidc\_provider\_client\_id\_list](#input\_tfc\_oidc\_provider\_client\_id\_list) | The list of client IDs to use for TFC | `list(string)` | n/a | yes |
Expand Down