Typescript: DataResource - CDK Terrain (CDKTN)

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 “cdktn get”. https://developer.hashicorp.com/terraform/language/resources/terraform-data

Initializers

import { DataResource } from 'cdktn'

new DataResource(scope: Construct, id: string, config?: DataConfig)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`string`	The scoped construct ID.
`config`	`DataConfig`	No description.

`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

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.
`addMoveTarget`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`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.
`hasResourceMove`	No description.
`importFrom`	No description.
`interpolationForAttribute`	No description.
`moveFromId`	Move the resource corresponding to “id” to this resource.
`moveTo`	Moves this resource to the target resource given by moveTarget.
`moveToId`	Moves this resource to the resource corresponding to “id”.
`resetInput`	No description.
`resetTriggersReplace`	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

`toMetadata`

public toMetadata(): any

`toTerraform`

public toTerraform(): any

Adds this resource to the terraform JSON output.

`addMoveTarget`

public addMoveTarget(moveTarget: string): void

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`

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

`hasResourceMove`

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

`importFrom`

public importFrom(id: string, provider?: TerraformProvider): void

`id`^Required

Type: string

`provider`^Optional

Type: TerraformProvider

`interpolationForAttribute`

public interpolationForAttribute(terraformAttribute: string): IResolvable

`terraformAttribute`^Required

Type: string

`moveFromId`

public moveFromId(id: string): void

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`

public moveTo(moveTarget: string, index?: string | number): void

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: string | number

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

`moveToId`

public moveToId(id: string): void

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`

public resetInput(): void

`resetTriggersReplace`

public resetTriggersReplace(): void

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isTerraformResource`	No description.
`generateConfigForImport`	Generates CDKTN code for importing a Data resource upon running “cdktn plan < stack-name >”.

`isConstruct`

import { DataResource } from 'cdktn'

DataResource.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 { DataResource } from 'cdktn'

DataResource.isTerraformElement(x: any)

`x`^Required

Type: any

`isTerraformResource`

import { DataResource } from 'cdktn'

DataResource.isTerraformResource(x: any)

`x`^Required

Type: any

`generateConfigForImport`

import { DataResource } from 'cdktn'

DataResource.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTN code for importing a Data resource upon running “cdktn 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 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

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.
`connection`	`SSHProvisionerConnection \| WinrmProvisionerConnection`	No description.
`count`	`number \| TerraformCount`	No description.
`dependsOn`	`string[]`	No description.
`forEach`	`ITerraformIterator`	No description.
`lifecycle`	`TerraformResourceLifecycle`	No description.
`provider`	`TerraformProvider`	No description.
`provisioners`	`FileProvisioner \| LocalExecProvisioner \| RemoteExecProvisioner[]`	No description.
`id`	`string`	No description.
`output`	`AnyMap`	No description.
`inputInput`	`{[ key: string ]: any}`	No description.
`triggersReplaceInput`	`{[ key: string ]: any}`	No description.
`input`	`{[ key: string ]: any}`	(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
`triggersReplace`	`{[ key: string ]: any}`	(Optional) A value which is stored in the instance state, and will force replacement when the value changes.

`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

`connection`^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

Type: SSHProvisionerConnection | WinrmProvisionerConnection

`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

`provisioners`^Optional

public readonly provisioners: (FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner)[];

Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]

`id`^Required

public readonly id: string;

Type: string

`output`^Required

public readonly output: AnyMap;

Type: AnyMap

`inputInput`^Optional

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

Type: {[ key: string ]: any}

`triggersReplaceInput`^Optional

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

Type: {[ key: string ]: any}

`input`^Required

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

Type: {[ key: string ]: any}

(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 readonly triggersReplace: {[ key: string ]: any};

Type: {[ key: string ]: any}

(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

Name	Type	Description
`tfResourceType`	`string`	No description.

`tfResourceType`^Required

public readonly tfResourceType: string;

Type: string

Overview

TypeScript

Python

Java

C#

Go

Documentation Index

​Initializers

​scopeRequired

​idRequired

​configOptional

​Methods

​toString

​addOverride

​pathRequired

​valueRequired

​overrideLogicalId

​newLogicalIdRequired

​resetOverrideLogicalId

​toHclTerraform

​toMetadata

​toTerraform

​addMoveTarget

​moveTargetRequired

​getAnyMapAttribute

​terraformAttributeRequired

​getBooleanAttribute

​terraformAttributeRequired

​getBooleanMapAttribute

​terraformAttributeRequired

​getListAttribute

​terraformAttributeRequired

​getNumberAttribute

​terraformAttributeRequired

​getNumberListAttribute

​terraformAttributeRequired

​getNumberMapAttribute

​terraformAttributeRequired

​getStringAttribute

​terraformAttributeRequired

​getStringMapAttribute

​terraformAttributeRequired

​hasResourceMove

​importFrom

​idRequired

​providerOptional

​interpolationForAttribute

​terraformAttributeRequired

​moveFromId

​idRequired

​moveTo

​moveTargetRequired

​indexOptional

​moveToId

​idRequired

​resetInput

​resetTriggersReplace

​Static Functions

​isConstruct

​xRequired

​isTerraformElement

​xRequired

​isTerraformResource

​xRequired

​generateConfigForImport

​scopeRequired

​importToIdRequired

​importFromIdRequired

​providerOptional

​Properties

​nodeRequired

​cdktfStackRequired

​fqnRequired

​friendlyUniqueIdRequired

​terraformMetaArgumentsRequired

​terraformResourceTypeRequired

​terraformGeneratorMetadataOptional

​connectionOptional

​countOptional

​dependsOnOptional

Initializers

`scope`^Required

`id`^Required

`config`^Optional

Methods

`toString`

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addMoveTarget`

`moveTarget`^Required

`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

`hasResourceMove`

`importFrom`

`id`^Required

`provider`^Optional

`interpolationForAttribute`

`terraformAttribute`^Required

`moveFromId`

`id`^Required

`moveTo`

`moveTarget`^Required

`index`^Optional

`moveToId`

`id`^Required

`resetInput`

`resetTriggersReplace`

Static Functions

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isTerraformResource`

`x`^Required

`generateConfigForImport`

`scope`^Required

`importToId`^Required

`importFromId`^Required

`provider`^Optional

Properties

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`terraformMetaArguments`^Required

`terraformResourceType`^Required

`terraformGeneratorMetadata`^Optional

`connection`^Optional

`count`^Optional

`dependsOn`^Optional

`forEach`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`id`^Required

`output`^Required

`inputInput`^Optional