Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Cloud Backend synthesizes a cloud block. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI’s behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings. https://developer.hashicorp.com/terraform/cli/cloud/settings#arguments

​
Initializer 

import { CloudBackendConfig } from 'cdktn'

const cloudBackendConfig: CloudBackendConfig = { ... }

​
Properties

NameTypeDescription
organizationstringThe name of the organization containing the workspace(s) the current configuration should use.
workspacesNamedCloudWorkspace | TaggedCloudWorkspacesA nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.
hostnamestringThe hostname of a Terraform Enterprise installation, if using Terraform Enterprise.
tokenstringThe token used to authenticate with Terraform Cloud.

​
organizationRequired 

public readonly organization: string;
  • Type: string
The name of the organization containing the workspace(s) the current configuration should use.

​
workspacesRequired 

public readonly workspaces: NamedCloudWorkspace | TaggedCloudWorkspaces;
A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. The workspaces block must contain exactly one of the following arguments, each denoting a strategy for how workspaces should be mapped:

​
hostnameOptional 

public readonly hostname: string;
  • Type: string
  • Default: app.terraform.io
The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.

​
tokenOptional 

public readonly token: string;
  • Type: string
The token used to authenticate with Terraform Cloud. We recommend omitting the token from the configuration, and instead using terraform login or manually configuring credentials in the CLI config file.