terraform/website/source/docs/backends/types/atlas.html.md

layout	page_title	sidebar_current	description
backend-types	Backend Type: atlas	docs-backends-types-standard-atlas	Terraform can store the state in Atlas.

atlas

Kind: Standard (with no locking)

Stores the state in Atlas.

You can create a new environment in the Environments section and generate new token in the Tokens page under Settings.

Example Configuration

terraform {
  backend "atlas" {
    name         = "bigbang/example"
    access_token = "foo"
  }
}

Note that for the access token we recommend using a partial configuration.

Example Referencing

data "terraform_remote_state" "foo" {
	backend = "atlas"
	config {
		name = "bigbang/example"
		access_token = "X2iTFefU5aWOjg.atlasv1.YaDa"
	}
}

Configuration variables

The following configuration options / environment variables are supported:

• name - (Required) Full name of the environment (<username>/<name>)
• access_token / ATLAS_TOKEN - (Required) Atlas API token
• address - (Optional) Address to alternative Atlas location (Atlas Enterprise endpoint)