Terraform module to provision and manage Terraform Cloud workspaces
Name | Version |
---|---|
terraform | >= 0.14.0 |
tfe | ~> 0.31.0 |
Name | Version |
---|---|
tfe | ~> 0.31.0 |
No modules.
Name | Type |
---|---|
tfe_run_trigger.this | resource |
tfe_variable.this | resource |
tfe_workspace.this | resource |
Name | Description | Type | Default | Required |
---|---|---|---|---|
allow_destroy_plan | (Optional) Whether destroy plans can be queued on the workspace | bool |
false |
no |
auto_apply | (Optional) Whether to automatically apply changes when a Terraform plan is successful | bool |
false |
no |
description | (Optional) A description for the workspace | string |
"" |
no |
environment_sensitive_variables | (Optional) Map of sensitive variables of 'environment' category used in the workspace Item syntax: { variable1_name = value1 variable2_name = value2 ... } |
map(any) |
{} |
no |
environment_variables | (Optional) Map of variables of 'environment' category used in the workspace Item syntax: { variable1_name = value1 variable2_name = value2 ... } |
map(any) |
{} |
no |
execution_mode | (Optional) Which execution mode to use | string |
"remote" |
no |
file_triggers_enabled | (Optional) Whether to filter runs based on the changed files in a VCS push | bool |
true |
no |
global_remote_state | (Optional) Whether the workspace allows all workspaces in the organization to access its state data during runs | bool |
false |
no |
name | (Required) Name of the workspace | string |
n/a | yes |
oauth_token_id | (Optional) The token ID of the VCS connection to use | string |
"" |
no |
organization | (Required) Name of the organization | string |
n/a | yes |
queue_all_runs | (Optional) Whether the workspace should start automatically performing runs immediately after its creation | bool |
true |
no |
remote_state_consumer_ids | (Optional) The set of workspace IDs set as explicit remote state consumers for the given workspace | list(string) |
[] |
no |
run_triggers | List of source workspaces IDs that trigger runs in this workspace | list(string) |
[] |
no |
speculative_enabled | (Optional) Whether this workspace allows speculative plans | bool |
true |
no |
ssh_key_id | (Optional) The ID of an SSH key to assign to the workspace | string |
null |
no |
structured_run_output_enabled | (Optional) Whether this workspace should show output from Terraform runs using the enhanced UI when available | bool |
true |
no |
tag_names | (Optional) A list of tag names for this workspace | list(string) |
[] |
no |
terraform_hcl_sensitive_variables | (Optional) Map of sensitive variables in HCL format of 'Terraform' category used in the workspace Item syntax: { variable1_name = value1 variable2_name = value2 ... } NOTE: you can specifies values in HCL format directly, like this: { variable_list = ["item1","item2"] variable_map = { key1 = value1 key2 = value2 } } |
any |
{} |
no |
terraform_hcl_variables | (Optional) Map of variables in HCL format of 'Terraform' category used in the workspace Item syntax: { variable1_name = value1 variable2_name = value2 ... } NOTE: you can specifies values in HCL format directly, like this: { variable_list = ["item1","item2"] variable_map = { key1 = value1 key2 = value2 } } } |
any |
{} |
no |
terraform_sensitive_variables | (Optional) Map of sensitive variables of 'Terraform' category used in the workspace Item syntax: { variable1_name = value1 variable2_name = value2 ... } |
map(any) |
{} |
no |
terraform_variables | (Optional) Map of variables of 'Terraform' category used in the workspace Item syntax: { variable1_name = value1 variable2_name = value2 ... } |
map(any) |
{} |
no |
terraform_version | (Required) The version of Terraform to use for this workspace | string |
n/a | yes |
trigger_prefixes | (Optional) List of repository-root-relative paths which describe all locations to be tracked for changes | list(string) |
[] |
no |
variables_descriptions | (Optional) Map of descriptions applied to workspace variables Item syntax: { variable1_name = "description" variable2_name = "description" ... } |
map(string) |
{} |
no |
vcs_repository_branch | (Optional) The repository branch that Terraform will execute from | string |
"" |
no |
vcs_repository_identifier | (Optional) A reference to your VCS repository in the format / where and refer to the organization and repository in your VCS provider. The format for Azure DevOps is //_git/ | string |
"" |
no |
vcs_repository_ingress_submodules | (Optional) Whether submodules should be fetched when cloning the VCS repository | bool |
false |
no |
working_directory | (Optional) A relative path that Terraform will execute within | string |
null |
no |
Name | Description |
---|---|
id | The workspace ID |