» tfe_variable

Creates, updates and destroys variables.

» Example Usage

Basic usage:

resource "tfe_organization" "test" {
  name  = "my-org-name"
  email = "admin@company.com"
}

resource "tfe_workspace" "test" {
  name         = "my-workspace-name"
  organization = "${tfe_organization.test.id}"
}

resource "tfe_variable" "test" {
  key          = "my_key_name"
  value        = "my_value_name"
  category     = "terraform"
  workspace_id = "${tfe_workspace.test.id}"
  description  = "a useful description"
}

» Argument Reference

The following arguments are supported:

  • key - (Required) Name of the variable.
  • value - (Required) Value of the variable.
  • category - (Required) Whether this is a Terraform or environment variable. Valid values are terraform or env.
  • description - (Optional) Description of the variable.
  • hcl - (Optional) Whether to evaluate the value of the variable as a string of HCL code. Has no effect for environment variables. Defaults to false.
  • sensitive - (Optional) Whether the value is sensitive. If true then the variable is written once and not visible thereafter. Defaults to false.
  • workspace_id - (Required) ID of the workspace that owns the variable.

» Attributes Reference

  • id - The ID of the variable.

» Import

Variables can be imported; use <ORGANIZATION NAME>/<WORKSPACE NAME>/<VARIABLE ID> as the import ID. For example:

terraform import tfe_variable.test my-org-name/my-workspace-name/var-5rTwnSaRPogw6apb