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.

HclOutput^Required

public bool HclOutput { get; }

• Type: bool

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.

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.

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

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.

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

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.

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

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.

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

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

DataResource

The DataResource implements the standard resource lifecycle, but does not directly take any other actions.

You can use the DataResource resource without requiring or configuring a provider.

The DataResource resource is useful for storing values which need to follow a manage resource lifecycle, and for triggering provisioners when there is no other logical managed resource in which to place them.

It requires Terraform 1.4 or later.

It is also possible to generate these bindings by adding "terraform.io/builtin/terraform" to the "terraformProviders" key in your cdktf.json file and running "cdktf get".

https://developer.hashicorp.com/terraform/language/resources/terraform-data

Initializers

using HashiCorp.Cdktf;

new DataResource(Construct Scope, string Id, DataConfig Config = null);

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

Id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

Config^Optional

• Type: DataConfig

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.

ToHclTerraform

private object ToHclTerraform()

ToMetadata

private object ToMetadata()

ToTerraform

private object ToTerraform()

Adds this resource to the terraform JSON output.

AddMoveTarget

private void AddMoveTarget(string MoveTarget)

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

MoveTarget^Required

• Type: string

The string move target that will correspond to this resource.

GetAnyMapAttribute

private System.Collections.Generic.IDictionary< string, object > GetAnyMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetBooleanAttribute

private IResolvable GetBooleanAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetBooleanMapAttribute

private System.Collections.Generic.IDictionary< string, bool > GetBooleanMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetListAttribute

private string[] GetListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetNumberAttribute

private double GetNumberAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetNumberListAttribute

private double[] GetNumberListAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetNumberMapAttribute

private System.Collections.Generic.IDictionary< string, double > GetNumberMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetStringAttribute

private string GetStringAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

GetStringMapAttribute

private System.Collections.Generic.IDictionary< string, string > GetStringMapAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

HasResourceMove

private object HasResourceMove()

ImportFrom

private void ImportFrom(string Id, TerraformProvider Provider = null)

Id^Required

• Type: string

Provider^Optional

• Type: TerraformProvider

InterpolationForAttribute

private IResolvable InterpolationForAttribute(string TerraformAttribute)

TerraformAttribute^Required

• Type: string

MoveFromId

private void MoveFromId(string Id)

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

Id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

MoveTo

private void MoveTo(string MoveTarget, object Index = null)

Moves this resource to the target resource given by moveTarget.

MoveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

Index^Optional

• Type: object

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

MoveToId

private void MoveToId(string Id)

Moves this resource to the resource corresponding to "id".

Id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

ResetInput

private void ResetInput()

ResetTriggersReplace

private void ResetTriggersReplace()

Static Functions

IsConstruct

using HashiCorp.Cdktf;

DataResource.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;

DataResource.IsTerraformElement(object X);

X^Required

• Type: object

IsTerraformResource

using HashiCorp.Cdktf;

DataResource.IsTerraformResource(object X);

X^Required

• Type: object

GenerateConfigForImport

using HashiCorp.Cdktf;

DataResource.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);

Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >".

Scope^Required

• Type: Constructs.Construct

The scope in which to define this construct.

ImportToId^Required

• Type: string

The construct id used in the generated config for the Data to import.

ImportFromId^Required

• Type: string

The id of the existing Data that should be imported.

Refer to the {@link https://terraform.io/providers/builtin/terraform/latest/docs/resources/data#import import section} in the documentation of this resource for the id to use

Provider^Optional

• Type: TerraformProvider

? Optional instance of the provider where the Data to import is found.

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

TerraformMetaArguments^Required

public System.Collections.Generic.IDictionary< string, object > TerraformMetaArguments { get; }

• Type: System.Collections.Generic.IDictionary< string, object >

TerraformResourceType^Required

public string TerraformResourceType { get; }

• Type: string

TerraformGeneratorMetadata^Optional

public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }

• Type: TerraformProviderGeneratorMetadata

Connection^Optional

public object Connection { get; }

• Type: object

Count^Optional

public object Count { get; }

• Type: object

DependsOn^Optional

public string[] DependsOn { get; }

• Type: string[]

ForEach^Optional

public ITerraformIterator ForEach { get; }

• Type: ITerraformIterator

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; }

• Type: TerraformResourceLifecycle

Provider^Optional

public TerraformProvider Provider { get; }

• Type: TerraformProvider

Provisioners^Optional

public object[] Provisioners { get; }

• Type: object[]

Id^Required

public string Id { get; }

• Type: string

Output^Required

public AnyMap Output { get; }

• Type: AnyMap

InputInput^Optional

public System.Collections.Generic.IDictionary< string, object > InputInput { get; }

• Type: System.Collections.Generic.IDictionary< string, object >

TriggersReplaceInput^Optional

public System.Collections.Generic.IDictionary< string, object > TriggersReplaceInput { get; }

• Type: System.Collections.Generic.IDictionary< string, object >

Input^Required

public System.Collections.Generic.IDictionary< string, object > Input { get; }

• Type: System.Collections.Generic.IDictionary< string, object >

(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.

https://developer.hashicorp.com/terraform/language/resources/terraform-data#input

TriggersReplace^Required

public System.Collections.Generic.IDictionary< string, object > TriggersReplace { get; }

• Type: System.Collections.Generic.IDictionary< string, object >

(Optional) A value which is stored in the instance state, and will force replacement when the value changes.

https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers_replace

Constants

TfResourceType^Required

public string TfResourceType { 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.

ToHclTerraform

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

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

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.

ToHclTerraform

private object ToHclTerraform()

Adds this resource to the terraform JSON output.

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.