CSharp: 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

using Io.Cdktn;

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

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`

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 TerraformResourceMoveByTarget|TerraformResourceMoveById 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, string|double 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: string|double

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

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`

using Io.Cdktn;

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 Io.Cdktn;

DataResource.IsTerraformElement(object X);

`X`^Required

Type: object

`IsTerraformResource`

using Io.Cdktn;

DataResource.IsTerraformResource(object X);

`X`^Required

Type: object

`GenerateConfigForImport`

using Io.Cdktn;

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

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`	`System.Collections.Generic.IDictionary< string, object >`	No description.
`TerraformResourceType`	`string`	No description.
`TerraformGeneratorMetadata`	`TerraformProviderGeneratorMetadata`	No description.
`Connection`	`SSHProvisionerConnection\|WinrmProvisionerConnection`	No description.
`Count`	`double\|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`	`System.Collections.Generic.IDictionary< string, object >`	No description.
`TriggersReplaceInput`	`System.Collections.Generic.IDictionary< string, object >`	No description.
`Input`	`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.
`TriggersReplace`	`System.Collections.Generic.IDictionary< string, object >`	(Optional) A value which is stored in the instance state, and will force replacement when the value changes.

`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 SSHProvisionerConnection|WinrmProvisionerConnection Connection { get; }

Type: SSHProvisionerConnection|WinrmProvisionerConnection

`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

`Provisioners`^Optional

public (FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner)[] Provisioners { get; }

Type: FileProvisioner|LocalExecProvisioner|RemoteExecProvisioner[]

`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

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

`TfResourceType`^Required

public string TfResourceType { get; }

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