»Terraform Cloud Configuration

The main module of a Terraform configuration can integrate with Terraform Cloud to enable its CLI-driven run workflow. You only need to configure these settings when you want to use Terraform CLI to interact with Terraform Cloud. Terraform Cloud ignores them when interacting with Terraform through version control or the API.

Hands On: Try the Migrate State to Terraform Cloud tutorial on HashiCorp Learn.

You can configure the Terraform Cloud CLI integration by adding a nested cloud block within the top-level terraform block:

terraform {
  cloud {
    organization = "example_corp"
    hostname = "app.terraform.io" # Optional; defaults to app.terraform.io

    workspaces {
      tags = ["app"]
    }
  }
}

terraform {
  cloud {
    organization = "example_corp"
    hostname = "app.terraform.io" # Optional; defaults to app.terraform.io

    workspaces {
      tags = ["app"]
    }
  }
}

If you do not specify the hostname, it defaults to app.terraform.io for Terraform Cloud. For Terraform Enterprise installations, include the hostname configuration argument.

You cannot use the CLI integration and a state backend in the same configuration; they are mutually exclusive. A configuration can only provide one cloud block and the cloud block cannot refer to named values like input variables, locals, or data source attributes.

Refer to Using Terraform Cloud in the Terraform CLI docs for more information.