terraform/website/docs/backends/types/terraform-enterprise.html.md

layout	page_title	sidebar_current	description
backend-types	Backend Type: terraform enterprise	docs-backends-types-standard-terraform-enterprise	Terraform can store its state in Terraform Enterprise

terraform enterprise

!> The atlas backend is deprecated. Please use the new enhanced remote backend for storing state and running remote operations in Terraform Cloud.

Kind: Standard (with no locking)

Reads and writes state from a Terraform Enterprise workspace.

-> Why is this called "atlas"? Before it was a standalone offering, Terraform Enterprise was part of an integrated suite of enterprise products called Atlas. This backend predates the current version Terraform Enterprise, so it uses the old name.

We no longer recommend using this backend, as it does not support collaboration features like workspace locking. Please use the new enhanced remote backend for storing state and running remote operations in Terraform Cloud.

Example Configuration

terraform {
  backend "atlas" {
    name = "example_corp/networking-prod"
    address = "https://app.terraform.io" # optional
  }
}

We recommend using a partial configuration and omitting the access token, which can be provided as an environment variable.

Example Referencing

data "terraform_remote_state" "foo" {
  backend = "atlas"
  config = {
    name = "example_corp/networking-prod"
  }
}

Configuration variables

The following configuration options / environment variables are supported:

• name - (Required) Full name of the workspace (<ORGANIZATION>/<WORKSPACE>).
• ATLAS_TOKEN/ access_token - (Optional) A Terraform Enterprise user API token. We recommend using the ATLAS_TOKEN environment variable rather than setting access_token in the configuration. If not set, the token will be requested during a terraform init and saved locally.
• address - (Optional) The URL of a Terraform Enterprise instance. Defaults to the SaaS version of Terraform Enterprise, at "https://app.terraform.io"; if you use a private install, provide its URL here.