API Reference for CSharp

Constructs

App

Represents a cdktf application.

Initializers

using HashiCorp.Cdktf;

new App(AppConfig Config = null);

Config^Optional

• Type: AppConfig

configuration.

Methods

ToString

private string ToString()

Returns a string representation of this construct.

CrossStackReference

private string CrossStackReference(TerraformStack FromStack, TerraformStack ToStack, string Identifier)

Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

FromStack^Required

• Type: TerraformStack

ToStack^Required

• Type: TerraformStack

Identifier^Required

• Type: string

Synth

private void Synth()

Synthesizes all resources to the output directory.

Static Functions

IsConstruct

using HashiCorp.Cdktf;

App.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.

IsApp

using HashiCorp.Cdktf;

App.IsApp(object X);

X^Required

• Type: object

Of

using HashiCorp.Cdktf;

App.Of(IConstruct Construct);

Construct^Required

• Type: Constructs.IConstruct

Properties

Node^Required

public Node Node { get; }

• Type: Constructs.Node

The tree node.

Manifest^Required

public Manifest Manifest { get; }

• Type: Manifest

Outdir^Required

public string Outdir { get; }

• Type: string

The output directory into which resources will be synthesized.

SkipBackendValidation^Required

public bool SkipBackendValidation { get; }

• Type: bool

Whether to skip backend validation during synthesis of the app.

SkipValidation^Required

public bool SkipValidation { get; }

• Type: bool

Whether to skip all validations during synthesis of the app.

TargetStackId^Optional

public string TargetStackId { get; }

• Type: string

The stack which will be synthesized.

If not set, all stacks will be synthesized.

ArtifactoryBackend

Initializers

using HashiCorp.Cdktf;

new ArtifactoryBackend(Construct Scope, ArtifactoryBackendConfig Props);

Scope^Required

• Type: Constructs.Construct

Props^Required

• Type: ArtifactoryBackendConfig

Methods

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.

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

IsConstruct

using HashiCorp.Cdktf;

ArtifactoryBackend.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 HashiCorp.Cdktf;

ArtifactoryBackend.IsTerraformElement(object X);

X^Required

• Type: object

IsBackend

using HashiCorp.Cdktf;

ArtifactoryBackend.IsBackend(object X);

X^Required

• Type: object

Properties

Node^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public Node Node { get; }

• Type: Constructs.Node

The tree node.

CdktfStack^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public TerraformStack CdktfStack { get; }

• Type: TerraformStack

Fqn^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public string Fqn { get; }

• Type: string

FriendlyUniqueId^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public string FriendlyUniqueId { get; }

• Type: string

AzurermBackend

Initializers

using HashiCorp.Cdktf;

new AzurermBackend(Construct Scope, AzurermBackendConfig Props);

Scope^Required

• Type: Constructs.Construct

Props^Required

• Type: AzurermBackendConfig

Methods

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.

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

IsConstruct

using HashiCorp.Cdktf;

AzurermBackend.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 HashiCorp.Cdktf;

AzurermBackend.IsTerraformElement(object X);

X^Required

• Type: object

IsBackend

using HashiCorp.Cdktf;

AzurermBackend.IsBackend(object X);

X^Required

• Type: object

Properties

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

CloudBackend

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block 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 HashiCorp.Cdktf;

new CloudBackend(Construct Scope, CloudBackendConfig Props);

Scope^Required

• Type: Constructs.Construct

Props^Required

• Type: CloudBackendConfig

Methods

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.

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

IsConstruct

using HashiCorp.Cdktf;

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 HashiCorp.Cdktf;

CloudBackend.IsTerraformElement(object X);

X^Required

• Type: object

IsBackend

using HashiCorp.Cdktf;

CloudBackend.IsBackend(object X);

X^Required

• Type: object

Properties

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

ConsulBackend

Initializers

using HashiCorp.Cdktf;

new ConsulBackend(Construct Scope, ConsulBackendConfig Props);

Scope^Required

• Type: Constructs.Construct

Props^Required

• Type: ConsulBackendConfig

Methods

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.

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

IsConstruct

using HashiCorp.Cdktf;

ConsulBackend.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 HashiCorp.Cdktf;

ConsulBackend.IsTerraformElement(object X);

X^Required

• Type: object

IsBackend

using HashiCorp.Cdktf;

ConsulBackend.IsBackend(object X);

X^Required

• Type: object

Properties

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

CosBackend

Initializers

using HashiCorp.Cdktf;

new CosBackend(Construct Scope, CosBackendConfig Props);

Scope^Required

• Type: Constructs.Construct

Props^Required

• Type: CosBackendConfig

Methods

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.

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

IsConstruct

using HashiCorp.Cdktf;

CosBackend.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 HashiCorp.Cdktf;

CosBackend.IsTerraformElement(object X);

X^Required

• Type: object

IsBackend

using HashiCorp.Cdktf;

CosBackend.IsBackend(object X);

X^Required

• Type: object

Properties

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

DataTerraformRemoteState

Initializers

using HashiCorp.Cdktf;

new DataTerraformRemoteState(Construct Scope, string Id, DataTerraformRemoteStateRemoteConfig Config);

Scope^Required

• Type: Constructs.Construct

Id^Required

• Type: string

Config^Required

• Type: DataTerraformRemoteStateRemoteConfig

Methods

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.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

Get

private IResolvable Get(string Output)

Output^Required

• Type: string

GetBoolean

private IResolvable GetBoolean(string Output)

Output^Required

• Type: string

GetList

private string[] GetList(string Output)

Output^Required

• Type: string

GetNumber

private double GetNumber(string Output)

Output^Required

• Type: string

GetString

private string GetString(string Output)

Output^Required

• Type: string

Static Functions

IsConstruct

using HashiCorp.Cdktf;

DataTerraformRemoteState.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 HashiCorp.Cdktf;

DataTerraformRemoteState.IsTerraformElement(object X);

X^Required

• Type: object

Properties

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

Constants

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

DataTerraformRemoteStateArtifactory

Initializers

using HashiCorp.Cdktf;

new DataTerraformRemoteStateArtifactory(Construct Scope, string Id, DataTerraformRemoteStateArtifactoryConfig Config);

Scope^Required

• Type: Constructs.Construct

Id^Required

• Type: string

Config^Required

• Type: DataTerraformRemoteStateArtifactoryConfig

Methods

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.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

Get

private IResolvable Get(string Output)

Output^Required

• Type: string

GetBoolean

private IResolvable GetBoolean(string Output)

Output^Required

• Type: string

GetList

private string[] GetList(string Output)

Output^Required

• Type: string

GetNumber

private double GetNumber(string Output)

Output^Required

• Type: string

GetString

private string GetString(string Output)

Output^Required

• Type: string

Static Functions

IsConstruct

using HashiCorp.Cdktf;

DataTerraformRemoteStateArtifactory.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 HashiCorp.Cdktf;

DataTerraformRemoteStateArtifactory.IsTerraformElement(object X);

X^Required

• Type: object

Properties

Node^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public Node Node { get; }

• Type: Constructs.Node

The tree node.

CdktfStack^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public TerraformStack CdktfStack { get; }

• Type: TerraformStack

Fqn^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public string Fqn { get; }

• Type: string

FriendlyUniqueId^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public string FriendlyUniqueId { get; }

• Type: string

Constants

TfResourceType^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public string TfResourceType { get; }

• Type: string

DataTerraformRemoteStateAzurerm

Initializers

using HashiCorp.Cdktf;

new DataTerraformRemoteStateAzurerm(Construct Scope, string Id, DataTerraformRemoteStateAzurermConfig Config);

Scope^Required

• Type: Constructs.Construct

Id^Required

• Type: string

Config^Required

• Type: DataTerraformRemoteStateAzurermConfig

Methods

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.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

Get

private IResolvable Get(string Output)

Output^Required

• Type: string

GetBoolean

private IResolvable GetBoolean(string Output)

Output^Required

• Type: string

GetList

private string[] GetList(string Output)

Output^Required

• Type: string

GetNumber

private double GetNumber(string Output)

Output^Required

• Type: string

GetString

private string GetString(string Output)

Output^Required

• Type: string

Static Functions

IsConstruct

using HashiCorp.Cdktf;

DataTerraformRemoteStateAzurerm.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 HashiCorp.Cdktf;

DataTerraformRemoteStateAzurerm.IsTerraformElement(object X);

X^Required

• Type: object

Properties

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

Constants

TfResourceType^Required

public string TfResourceType { get; }

• Type: string

DataTerraformRemoteStateConsul

Initializers

using HashiCorp.Cdktf;

new DataTerraformRemoteStateConsul(Construct Scope, string Id, DataTerraformRemoteStateConsulConfig Config);

Scope^Required

• Type: Constructs.Construct

Id^Required

• Type: string

Config^Required

• Type: DataTerraformRemoteStateConsulConfig

Methods

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.

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

Get

private IResolvable Get(string Output)

Output^Required

• Type: string

GetBoolean

private IResolvable GetBoolean(string Output)

Output^Required

• Type: string

GetList

private string[] GetList(string Output)

Output^Required

• Type: string

GetNumber

private double GetNumber(string Output)