From 3fc8d3ac84931a643a2624b0ff03e2c9a3487dba Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 8 Aug 2024 08:39:51 +0000 Subject: [PATCH] docs(readme): update module usage --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8f7163..3d3b9fd 100644 --- a/README.md +++ b/README.md @@ -246,7 +246,7 @@ module "aws_account" { | [name](#input\_name) | Name of the account and default TFE workspace | `string` | n/a | yes | | [tfe\_workspace](#input\_tfe\_workspace) | TFE workspace settings | 
object({
    add_permissions_boundary       = optional(bool, false)
    agent_pool_id                  = optional(string)
    agent_role_arns                = optional(list(string))
    allow_destroy_plan             = optional(bool, true)
    assessments_enabled            = optional(bool, true)
    auth_method                    = optional(string, "iam_role_oidc")
    auto_apply                     = optional(bool, false)
    auto_apply_run_trigger         = optional(bool, false)
    branch                         = optional(string, "main")
    clear_text_env_variables       = optional(map(string), {})
    clear_text_hcl_variables       = optional(map(string), {})
    clear_text_terraform_variables = optional(map(string), {})
    connect_vcs_repo               = optional(bool, true)
    default_region                 = string
    description                    = optional(string)
    execution_mode                 = optional(string, "remote")
    file_triggers_enabled          = optional(bool, true)
    global_remote_state            = optional(bool, false)
    name                           = optional(string)
    organization                   = string
    policy                         = optional(string)
    policy_arns                    = optional(list(string), ["arn:aws:iam::aws:policy/AdministratorAccess"])
    project_id                     = optional(string)
    queue_all_runs                 = optional(bool)
    remote_state_consumer_ids      = optional(set(string))
    repository_identifier          = optional(string)
    role_name                      = optional(string, "TFEPipeline")
    sensitive_env_variables        = optional(map(string), {})
    sensitive_hcl_variables        = optional(map(object({ sensitive = string })), {})
    sensitive_terraform_variables  = optional(map(string), {})
    ssh_key_id                     = optional(string)
    terraform_version              = optional(string)
    trigger_patterns               = optional(list(string))
    trigger_prefixes               = optional(list(string), ["modules"])
    username                       = optional(string, "TFEPipeline")
    vcs_oauth_token_id             = string
    variable_set_ids               = optional(map(string), {})
    working_directory              = optional(string)
    workspace_tags                 = optional(list(string))

    notification_configuration = optional(map(object({
      destination_type = string
      enabled          = optional(bool, true)
      url              = string
      triggers = optional(list(string), [
        "run:created",
        "run:planning",
        "run:needs_attention",
        "run:applying",
        "run:completed",
        "run:errored",
      ])
    })), {})

    team_access = optional(map(object({
      access = optional(string, null),
      permissions = optional(object({
        run_tasks         = bool
        runs              = string
        sentinel_mocks    = string
        state_versions    = string
        variables         = string
        workspace_locking = bool
      }), null)
    })), {})
  })
| n/a | yes | | [account\_variable\_set](#input\_account\_variable\_set) | Settings of variable set that is attached to each workspace | 
object({
    name                           = optional(string)
    clear_text_env_variables       = optional(map(string), {})
    clear_text_hcl_variables       = optional(map(string), {})
    clear_text_terraform_variables = optional(map(string), {})
  })
| `{}` | no | -| [additional\_tfe\_workspaces](#input\_additional\_tfe\_workspaces) | Additional TFE workspaces | 
map(object({
    add_permissions_boundary       = optional(bool, false)
    agent_pool_id                  = optional(string)
    agent_role_arns                = optional(list(string))
    allow_destroy_plan             = optional(bool)
    assessments_enabled            = optional(bool)
    auth_method                    = optional(string)
    auto_apply                     = optional(bool, false)
    auto_apply_run_trigger         = optional(bool, false)
    branch                         = optional(string)
    clear_text_env_variables       = optional(map(string), {})
    clear_text_hcl_variables       = optional(map(string), {})
    clear_text_terraform_variables = optional(map(string), {})
    connect_vcs_repo               = optional(bool, true)
    default_region                 = optional(string)
    description                    = optional(string)
    execution_mode                 = optional(string)
    file_triggers_enabled          = optional(bool, true)
    global_remote_state            = optional(bool, false)
    name                           = optional(string)
    policy                         = optional(string)
    policy_arns                    = optional(list(string), ["arn:aws:iam::aws:policy/AdministratorAccess"])
    project_id                     = optional(string)
    queue_all_runs                 = optional(bool)
    remote_state_consumer_ids      = optional(set(string))
    repository_identifier          = optional(string)
    role_name                      = optional(string)
    sensitive_env_variables        = optional(map(string), {})
    sensitive_hcl_variables        = optional(map(object({ sensitive = string })), {})
    sensitive_terraform_variables  = optional(map(string), {})
    ssh_key_id                     = optional(string)
    terraform_version              = optional(string)
    trigger_patterns               = optional(list(string))
    trigger_prefixes               = optional(list(string))
    username                       = optional(string)
    vcs_oauth_token_id             = optional(string)
    variable_set_ids               = optional(map(string), {})
    working_directory              = optional(string)
    workspace_tags                 = optional(list(string))

    notification_configuration = optional(map(object({
      destination_type = string
      enabled          = optional(bool, true)
      url              = string
      triggers = optional(list(string), [
        "run:created",
        "run:planning",
        "run:needs_attention",
        "run:applying",
        "run:completed",
        "run:errored",
      ])
    })), {})

    team_access = optional(map(object({
      access = optional(string, null),
      permissions = optional(object({
        run_tasks         = bool
        runs              = string
        sentinel_mocks    = string
        state_versions    = string
        variables         = string
        workspace_locking = bool
      }), null)
    })), {})
  }))
| `{}` | no | +| [additional\_tfe\_workspaces](#input\_additional\_tfe\_workspaces) | Additional TFE workspaces | 
map(object({
    add_permissions_boundary       = optional(bool, false)
    agent_pool_id                  = optional(string)
    agent_role_arns                = optional(list(string))
    allow_destroy_plan             = optional(bool)
    assessments_enabled            = optional(bool)
    auth_method                    = optional(string)
    auto_apply                     = optional(bool, false)
    auto_apply_run_trigger         = optional(bool, false)
    branch                         = optional(string)
    clear_text_env_variables       = optional(map(string), {})
    clear_text_hcl_variables       = optional(map(string), {})
    clear_text_terraform_variables = optional(map(string), {})
    connect_vcs_repo               = optional(bool, true)
    default_region                 = optional(string)
    description                    = optional(string)
    execution_mode                 = optional(string)
    file_triggers_enabled          = optional(bool, true)
    global_remote_state            = optional(bool, false)
    name                           = optional(string)
    policy                         = optional(string)
    policy_arns                    = optional(list(string), ["arn:aws:iam::aws:policy/AdministratorAccess"])
    project_id                     = optional(string)
    queue_all_runs                 = optional(bool)
    remote_state_consumer_ids      = optional(set(string))
    repository_identifier          = optional(string)
    role_name                      = optional(string)
    sensitive_env_variables        = optional(map(string), {})
    sensitive_hcl_variables        = optional(map(object({ sensitive = string })), {})
    sensitive_terraform_variables  = optional(map(string), {})
    ssh_key_id                     = optional(string)
    terraform_version              = optional(string)
    trigger_patterns               = optional(list(string))
    trigger_prefixes               = optional(list(string))
    username                       = optional(string)
    vcs_oauth_token_id             = optional(string)
    variable_set_ids               = optional(map(string), {})
    working_directory              = optional(string)
    workspace_tags                 = optional(list(string))

    notification_configuration = optional(map(object({
      destination_type = string
      enabled          = optional(bool, true)
      url              = string
      triggers = optional(list(string), [
        "run:created",
        "run:planning",
        "run:needs_attention",
        "run:applying",
        "run:completed",
        "run:errored",
      ])
    })), null)

    team_access = optional(map(object({
      access = optional(string, null),
      permissions = optional(object({
        run_tasks         = bool
        runs              = string
        sentinel_mocks    = string
        state_versions    = string
        variables         = string
        workspace_locking = bool
      }), null)
    })), null)
  }))
| `{}` | no | | [create\_default\_workspace](#input\_create\_default\_workspace) | Set to false to skip creating default workspace | `bool` | `true` | no | | [path](#input\_path) | Optional path for all IAM users, user groups, roles, and customer managed policies created by this module | `string` | `"/"` | no | | [permissions\_boundaries](#input\_permissions\_boundaries) | n/a | 
object({
    workspace_boundary      = optional(string)
    workspace_boundary_name = optional(string)
    workload_boundary       = optional(string)
    workload_boundary_name  = optional(string)
  })
| `{}` | no |