CSharp: TerraformDataSource - CDK Terrain (CDKTN)

Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent

Initializers

using Io.Cdktn;

new TerraformDataSource(Construct Scope, string Id, TerraformResourceConfig Config);

Name	Type	Description
`Scope`	`Constructs.Construct`	No description.
`Id`	`string`	No description.
`Config`	`TerraformResourceConfig`	No description.

`Scope`^Required

Type: Constructs.Construct

`Id`^Required

Type: string

`Config`^Required

Type: TerraformResourceConfig

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`	Adds this resource to the terraform JSON output.
`ToMetadata`	No description.
`ToTerraform`	Adds this resource to the terraform JSON output.
`GetAnyMapAttribute`	No description.
`GetBooleanAttribute`	No description.
`GetBooleanMapAttribute`	No description.
`GetListAttribute`	No description.
`GetNumberAttribute`	No description.
`GetNumberListAttribute`	No description.
`GetNumberMapAttribute`	No description.
`GetStringAttribute`	No description.
`GetStringMapAttribute`	No description.
`InterpolationForAttribute`	No description.

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

`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

`InterpolationForAttribute`

private IResolvable InterpolationForAttribute(string TerraformAttribute)

`TerraformAttribute`^Required

Type: string

Static Functions

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

`IsConstruct`

using Io.Cdktn;

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

TerraformDataSource.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformDataSource`

using Io.Cdktn;

TerraformDataSource.IsTerraformDataSource(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.
`TerraformMetaArguments`	`System.Collections.Generic.IDictionary< string, object >`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`TerraformProviderGeneratorMetadata`	No description.
`Count`	`double\|TerraformCount`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`ITerraformIterator`	No description.
`Lifecycle`	`TerraformResourceLifecycle`	No description.
`Provider`	`TerraformProvider`	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

`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

`Count`^Optional

public double|TerraformCount Count { get; }

Type: double|TerraformCount

`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

Overview

TypeScript

Python

Java

C#

Go

Documentation Index

​Initializers

​ScopeRequired

​IdRequired

​ConfigRequired

​Methods

​ToString

​AddOverride

​PathRequired

​ValueRequired

​OverrideLogicalId

​NewLogicalIdRequired

​ResetOverrideLogicalId

​ToHclTerraform

​ToMetadata

​ToTerraform

​GetAnyMapAttribute

​TerraformAttributeRequired

​GetBooleanAttribute

​TerraformAttributeRequired

​GetBooleanMapAttribute

​TerraformAttributeRequired

​GetListAttribute

​TerraformAttributeRequired

​GetNumberAttribute

​TerraformAttributeRequired

​GetNumberListAttribute

​TerraformAttributeRequired

​GetNumberMapAttribute

​TerraformAttributeRequired

​GetStringAttribute

​TerraformAttributeRequired

​GetStringMapAttribute

​TerraformAttributeRequired

​InterpolationForAttribute

​TerraformAttributeRequired

​Static Functions

​IsConstruct

​XRequired

​IsTerraformElement

​XRequired

​IsTerraformDataSource

​XRequired

​Properties

​NodeRequired

​CdktfStackRequired

​FqnRequired

​FriendlyUniqueIdRequired

​TerraformMetaArgumentsRequired

​TerraformResourceTypeRequired

​TerraformGeneratorMetadataOptional

​CountOptional

​DependsOnOptional

​ForEachOptional

​LifecycleOptional

​ProviderOptional

Initializers

`Scope`^Required

`Id`^Required

`Config`^Required

Methods

`ToString`

`AddOverride`

`Path`^Required

`Value`^Required

`OverrideLogicalId`

`NewLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`GetAnyMapAttribute`

`TerraformAttribute`^Required

`GetBooleanAttribute`

`TerraformAttribute`^Required

`GetBooleanMapAttribute`

`TerraformAttribute`^Required

`GetListAttribute`

`TerraformAttribute`^Required

`GetNumberAttribute`

`TerraformAttribute`^Required

`GetNumberListAttribute`

`TerraformAttribute`^Required

`GetNumberMapAttribute`

`TerraformAttribute`^Required

`GetStringAttribute`

`TerraformAttribute`^Required

`GetStringMapAttribute`

`TerraformAttribute`^Required

`InterpolationForAttribute`

`TerraformAttribute`^Required

Static Functions

`IsConstruct`

`X`^Required

`IsTerraformElement`

`X`^Required

`IsTerraformDataSource`

`X`^Required

Properties

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`TerraformMetaArguments`^Required

`TerraformResourceType`^Required

`TerraformGeneratorMetadata`^Optional

`Count`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Lifecycle`^Optional

`Provider`^Optional