Typescript: TerraformDataSource - CDK Terrain (CDKTN)

Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent

Initializers

import { TerraformDataSource } from 'cdktn'

new TerraformDataSource(scope: Construct, id: string, config: TerraformResourceConfig)

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`

public toString(): string

Returns a string representation of this construct.

`addOverride`

public addOverride(path: string, value: any): void

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

public overrideLogicalId(newLogicalId: string): void

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`

public resetOverrideLogicalId(): void

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

`toHclTerraform`

public toHclTerraform(): any

Adds this resource to the terraform JSON output.

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`getAnyMapAttribute`

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

`terraformAttribute`^Required

Type: string

`getBooleanAttribute`

public getBooleanAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`getBooleanMapAttribute`

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

`terraformAttribute`^Required

Type: string

`getListAttribute`

public getListAttribute(terraformAttribute: string): string[]

`terraformAttribute`^Required

Type: string

`getNumberAttribute`

public getNumberAttribute(terraformAttribute: string): number

`terraformAttribute`^Required

Type: string

`getNumberListAttribute`

public getNumberListAttribute(terraformAttribute: string): number[]

`terraformAttribute`^Required

Type: string

`getNumberMapAttribute`

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

`terraformAttribute`^Required

Type: string

`getStringAttribute`

public getStringAttribute(terraformAttribute: string): string

`terraformAttribute`^Required

Type: string

`getStringMapAttribute`

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

`terraformAttribute`^Required

Type: string

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformDataSource`	No description.

`isConstruct`

import { TerraformDataSource } from 'cdktn'

TerraformDataSource.isConstruct(x: 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: any

Any object.

`isTerraformElement`

import { TerraformDataSource } from 'cdktn'

TerraformDataSource.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformDataSource`

import { TerraformDataSource } from 'cdktn'

TerraformDataSource.isTerraformDataSource(x: any)

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`cdktfStack`	`TerraformStack`	No description.
`fqn`	`string`	No description.
`friendlyUniqueId`	`string`	No description.
`terraformMetaArguments`	`{[ key: string ]: any}`	No description.
`terraformResourceType`	`string`	No description.
`terraformGeneratorMetadata`	`TerraformProviderGeneratorMetadata`	No description.
`count`	`number \| TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`ITerraformIterator`	No description.
`lifecycle`	`TerraformResourceLifecycle`	No description.
`provider`	`TerraformProvider`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`terraformMetaArguments`^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

Type: {[ key: string ]: any}

`terraformResourceType`^Required

public readonly terraformResourceType: string;

Type: string

`terraformGeneratorMetadata`^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

Type: TerraformProviderGeneratorMetadata

`count`^Optional

public readonly count: number | TerraformCount;

Type: number | TerraformCount

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: ITerraformIterator

`lifecycle`^Optional

public readonly lifecycle: TerraformResourceLifecycle;

Type: TerraformResourceLifecycle

`provider`^Optional

public readonly provider: TerraformProvider;

Type: TerraformProvider

Overview

TypeScript

Python

Java

C#

Go

​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