Python: CloudBackend

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.

Initializers

import cdktn

cdktn.CloudBackend(
  scope: Construct,
  organization: str,
  workspaces: NamedCloudWorkspace | TaggedCloudWorkspaces,
  hostname: str = None,
  token: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`organization`	`str`	The name of the organization containing the workspace(s) the current configuration should use.
`workspaces`	`NamedCloudWorkspace \| TaggedCloudWorkspaces`	A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.
`hostname`	`str`	The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.
`token`	`str`	The token used to authenticate with Terraform Cloud.

`scope`^Required

Type: constructs.Construct

`organization`^Required

Type: str

The name of the organization containing the workspace(s) the current configuration should use.

`workspaces`^Required

Type: 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:

`hostname`^Optional

Type: str
Default: app.terraform.io

The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.

`token`^Optional

Type: str

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.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`get_remote_state_data_source`	Creates a TerraformRemoteState resource that accesses this backend.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`get_remote_state_data_source`

def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) -> TerraformRemoteState

Creates a TerraformRemoteState resource that accesses this backend.

`scope`^Required

Type: constructs.Construct

`name`^Required

Type: str

`_fromstack`^Required

Type: str

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_backend`	No description.

`is_construct`

import cdktn

cdktn.CloudBackend.is_construct(
  x: typing.Any
)

Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: typing.Any

Any object.

`is_terraform_element`

import cdktn

cdktn.CloudBackend.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_backend`

import cdktn

cdktn.CloudBackend.is_backend(
  x: typing.Any
)

`x`^Required

Type: typing.Any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktf_stack`	`TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

Overview

TypeScript

Python

Java

C#

Go

Initializers

`scope`^Required

`organization`^Required

`workspaces`^Required

`hostname`^Optional

`token`^Optional

Methods

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`get_remote_state_data_source`

`scope`^Required

`name`^Required

`_fromstack`^Required

Static Functions

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_backend`

`x`^Required

Properties

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​scopeRequired

​organizationRequired

​workspacesRequired

​hostnameOptional

​tokenOptional

​Methods

​to_string

​add_override

​pathRequired

​valueRequired

​override_logical_id

​new_logical_idRequired

​reset_override_logical_id

​to_hcl_terraform

​to_metadata

​to_terraform

​get_remote_state_data_source

​scopeRequired

​nameRequired

​_fromstackRequired

​Static Functions

​is_construct

​xRequired

​is_terraform_element

​xRequired

​is_backend

​xRequired

​Properties

​nodeRequired

​cdktf_stackRequired

​fqnRequired

​friendly_unique_idRequired

Initializers

`scope`^Required

`organization`^Required

`workspaces`^Required

`hostname`^Optional

`token`^Optional

Methods

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`get_remote_state_data_source`

`scope`^Required

`name`^Required

`_fromstack`^Required

Static Functions

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_backend`

`x`^Required

Properties

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required