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

using Io.Cdktn;

new CloudBackend(Construct Scope, CloudBackendConfig Props);

Name	Type	Description
`Scope`	`Constructs.Construct`	No description.
`Props`	`CloudBackendConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

`Props`^Required

Type: CloudBackendConfig

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`AddOverride`	No description.
`OverrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`ResetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`ToHclTerraform`	No description.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`GetRemoteStateDataSource`	Creates a TerraformRemoteState resource that accesses this backend.

`ToString`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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

`NewLogicalId`^Required

Type: string

The new logical ID to use for this stack element.

`ResetOverrideLogicalId`

private void ResetOverrideLogicalId()

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

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

Adds this resource to the terraform JSON output.

`GetRemoteStateDataSource`

private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)

Creates a TerraformRemoteState resource that accesses this backend.

`Scope`^Required

Type: Constructs.Construct

`Name`^Required

Type: string

`FromStack`^Required

Type: string

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.
`IsBackend`	No description.

`IsConstruct`

using Io.Cdktn;

CloudBackend.IsConstruct(object X);

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

Any object.

`IsTerraformElement`

using Io.Cdktn;

CloudBackend.IsTerraformElement(object X);

`X`^Required

Type: object

`IsBackend`

using Io.Cdktn;

CloudBackend.IsBackend(object X);

`X`^Required

Type: object

Properties

Name	Type	Description
`Node`	`Constructs.Node`	The tree node.
`CdktfStack`	`TerraformStack`	No description.
`Fqn`	`string`	No description.
`FriendlyUniqueId`	`string`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

Overview

TypeScript

Python

Java

C#

Go

Initializers

`Scope`^Required

`Props`^Required

Methods

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`GetRemoteStateDataSource`

`Scope`^Required

`Name`^Required

`FromStack`^Required

Static Functions

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsBackend`

`X`^Required

Properties

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​ScopeRequired

​PropsRequired

​Methods

​ToString

​AddOverride

​PathRequired

​ValueRequired

​OverrideLogicalId

​NewLogicalIdRequired

​ResetOverrideLogicalId

​ToHclTerraform

​ToMetadata

​ToTerraform

​GetRemoteStateDataSource

​ScopeRequired

​NameRequired

​FromStackRequired

​Static Functions

​IsConstruct

​XRequired

​IsTerraformElement

​XRequired

​IsBackend

​XRequired

​Properties

​NodeRequired

​CdktfStackRequired

​FqnRequired

​FriendlyUniqueIdRequired

Initializers

`Scope`^Required

`Props`^Required

Methods

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`GetRemoteStateDataSource`

`Scope`^Required

`Name`^Required

`FromStack`^Required

Static Functions

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsBackend`

`X`^Required

Properties

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required