From 115d4b126b936cebf3ce83df11c11ed72dac681f Mon Sep 17 00:00:00 2001 From: lusitania Date: Tue, 12 Nov 2024 12:55:13 +0100 Subject: [PATCH] fix README Signed-off-by: lusitania --- README.md | 4 ++-- modules/iam_roles/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 60b7d81..73fc1dd 100644 --- a/README.md +++ b/README.md @@ -103,8 +103,8 @@ module "aws_dynamic_provider_credentials" { | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| | [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 | -| [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. | 
set(object({
    Effect   = string
    Action   = set(string)
    Resource = string
  }))
| `[]` | no | -| [statements](#input\_statements) | The list of statements to use for the trust relationship | 
set(object({
    org_name     = string
    project_name = string
    workspace    = string
    run_phase    = optional(string, "*")
  }))
| n/a | yes | +| [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. | 
set(object({
    Effect   = string
    Action   = set(string)
    Resource = string
  }))
| `[]` | no | +| [statements](#input\_statements) | The list of statements to use for the trust relationship | 
set(object({
    org_name     = string
    project_name = string
    workspace    = string
    run_phase    = optional(string, "*")
  }))
| n/a | yes | | [tfc\_aws\_audience](#input\_tfc\_aws\_audience) | AWS audience | `string` | `"aws.workload.identity"` | no | | [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 | | [tfc\_organization](#input\_tfc\_organization) | Name of the organization | `string` | n/a | yes | diff --git a/modules/iam_roles/README.md b/modules/iam_roles/README.md index 774786c..b89138b 100644 --- a/modules/iam_roles/README.md +++ b/modules/iam_roles/README.md @@ -25,9 +25,9 @@ No modules. | Name | Description | Type | Default | Required | |------|-------------|------|---------|:--------:| -| [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. | 
list(object({
    Effect   = string
    Action   = list(string)
    Resource = string
  }))
| 
[
  {
    "Action": [
      "ec2:*"
    ],
    "Effect": "Allow",
    "Resource": "*"
  }
]
| no | +| [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. | 
list(object({
    Effect   = string
    Action   = list(string)
    Resource = string
  }))
| 
[
  {
    "Action": [
      "ec2:*"
    ],
    "Effect": "Allow",
    "Resource": "*"
  }
]
| no | | [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 | -| [statements](#input\_statements) | The list of statements to use for the trust relationship | 
set(object({
    org_name     = string
    project_name = string
    workspace    = string
    run_phase    = string
  }))
| n/a | yes | +| [statements](#input\_statements) | The list of statements to use for the trust relationship | 
set(object({
    org_name     = string
    project_name = string
    workspace    = string
    run_phase    = string
  }))
| n/a | yes | | [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 | | [tfc\_oidc\_provider\_arn](#input\_tfc\_oidc\_provider\_arn) | The ARN of the OIDC provider to use for TFC | `string` | n/a | yes | | [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 |