Python: 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 cdktn

cdktn.DataResource(
  scope: Construct,
  id: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  count: typing.Union[int, float] | TerraformCount = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] = None,
  input: typing.Mapping[typing.Any] = None,
  triggers_replace: typing.Mapping[typing.Any] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	The scope in which to define this construct.
`id`	`str`	The scoped construct ID.
`connection`	`SSHProvisionerConnection \| WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| TerraformCount`	No description.
`depends_on`	`typing.List[ITerraformDependable]`	No description.
`for_each`	`ITerraformIterator`	No description.
`lifecycle`	`TerraformResourceLifecycle`	No description.
`provider`	`TerraformProvider`	No description.
`provisioners`	`typing.List[FileProvisioner \| LocalExecProvisioner \| RemoteExecProvisioner]`	No description.
`input`	`typing.Mapping[typing.Any]`	(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
`triggers_replace`	`typing.Mapping[typing.Any]`	(Optional) A value which is stored in the instance state, and will force replacement when the value changes.

`scope`^Required

Type: constructs.Construct

The scope in which to define this construct.

`id`^Required

Type: str

The scoped construct ID. Must be unique amongst siblings in the same scope

`connection`^Optional

Type: SSHProvisionerConnection | WinrmProvisionerConnection

`count`^Optional

Type: typing.Union[int, float] | TerraformCount

`depends_on`^Optional

Type: typing.List[ITerraformDependable]

`input`^Optional

Type: typing.Mapping[typing.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

`triggers_replace`^Optional

Type: typing.Mapping[typing.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

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`add_override`	No description.
`override_logical_id`	Overrides the auto-generated logical ID with a specific ID.
`reset_override_logical_id`	Resets a previously passed logical Id to use the auto-generated logical id again.
`to_hcl_terraform`	No description.
`to_metadata`	No description.
`to_terraform`	Adds this resource to the terraform JSON output.
`add_move_target`	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
`get_any_map_attribute`	No description.
`get_boolean_attribute`	No description.
`get_boolean_map_attribute`	No description.
`get_list_attribute`	No description.
`get_number_attribute`	No description.
`get_number_list_attribute`	No description.
`get_number_map_attribute`	No description.
`get_string_attribute`	No description.
`get_string_map_attribute`	No description.
`has_resource_move`	No description.
`import_from`	No description.
`interpolation_for_attribute`	No description.
`move_from_id`	Move the resource corresponding to “id” to this resource.
`move_to`	Moves this resource to the target resource given by moveTarget.
`move_to_id`	Moves this resource to the resource corresponding to “id”.
`reset_input`	No description.
`reset_triggers_replace`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`add_override`

def add_override(
  path: str,
  value: typing.Any
) -> None

`path`^Required

Type: str

`value`^Required

Type: typing.Any

`override_logical_id`

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

`new_logical_id`^Required

Type: str

The new logical ID to use for this stack element.

`reset_override_logical_id`

def reset_override_logical_id() -> None

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

`to_hcl_terraform`

def to_hcl_terraform() -> typing.Any

`to_metadata`

def to_metadata() -> typing.Any

`to_terraform`

def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

`add_move_target`

def add_move_target(
  move_target: str
) -> None

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

`move_target`^Required

Type: str

The string move target that will correspond to this resource.

`get_any_map_attribute`

def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]

`terraform_attribute`^Required

Type: str

`get_boolean_attribute`

def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`get_boolean_map_attribute`

def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]

`terraform_attribute`^Required

Type: str

`get_list_attribute`

def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]

`terraform_attribute`^Required

Type: str

`get_number_attribute`

def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]

`terraform_attribute`^Required

Type: str

`get_number_list_attribute`

def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_number_map_attribute`

def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]

`terraform_attribute`^Required

Type: str

`get_string_attribute`

def get_string_attribute(
  terraform_attribute: str
) -> str

`terraform_attribute`^Required

Type: str

`get_string_map_attribute`

def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]

`terraform_attribute`^Required

Type: str

`has_resource_move`

def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById

`import_from`

def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None

`id`^Required

Type: str

`provider`^Optional

Type: TerraformProvider

`interpolation_for_attribute`

def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable

`terraform_attribute`^Required

Type: str

`move_from_id`

def move_from_id(
  id: str
) -> None

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

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

`move_to`

def move_to(
  move_target: str,
  index: str | typing.Union[int, float] = None
) -> None

Moves this resource to the target resource given by moveTarget.

`move_target`^Required

Type: str

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

`index`^Optional

Type: str | typing.Union[int, float]

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

`move_to_id`

def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to “id”.

`id`^Required

Type: str

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

`reset_input`

def reset_input() -> None

`reset_triggers_replace`

def reset_triggers_replace() -> None

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.
`is_terraform_element`	No description.
`is_terraform_resource`	No description.
`generate_config_for_import`	Generates CDKTN code for importing a Data resource upon running “cdktn plan < stack-name >”.

`is_construct`

import cdktn

cdktn.DataResource.is_construct(
  x: typing.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: typing.Any

Any object.

`is_terraform_element`

import cdktn

cdktn.DataResource.is_terraform_element(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`is_terraform_resource`

import cdktn

cdktn.DataResource.is_terraform_resource(
  x: typing.Any
)

`x`^Required

Type: typing.Any

`generate_config_for_import`

import cdktn

cdktn.DataResource.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

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.

`import_to_id`^Required

Type: str

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

`import_from_id`^Required

Type: str

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.
`cdktf_stack`	`TerraformStack`	No description.
`fqn`	`str`	No description.
`friendly_unique_id`	`str`	No description.
`terraform_meta_arguments`	`typing.Mapping[typing.Any]`	No description.
`terraform_resource_type`	`str`	No description.
`terraform_generator_metadata`	`TerraformProviderGeneratorMetadata`	No description.
`connection`	`SSHProvisionerConnection \| WinrmProvisionerConnection`	No description.
`count`	`typing.Union[int, float] \| TerraformCount`	No description.
`depends_on`	`typing.List[str]`	No description.
`for_each`	`ITerraformIterator`	No description.
`lifecycle`	`TerraformResourceLifecycle`	No description.
`provider`	`TerraformProvider`	No description.
`provisioners`	`typing.List[FileProvisioner \| LocalExecProvisioner \| RemoteExecProvisioner]`	No description.
`id`	`str`	No description.
`output`	`AnyMap`	No description.
`input_input`	`typing.Mapping[typing.Any]`	No description.
`triggers_replace_input`	`typing.Mapping[typing.Any]`	No description.
`input`	`typing.Mapping[typing.Any]`	(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
`triggers_replace`	`typing.Mapping[typing.Any]`	(Optional) A value which is stored in the instance state, and will force replacement when the value changes.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`cdktf_stack`^Required

cdktf_stack: TerraformStack

Type: TerraformStack

`fqn`^Required

fqn: str

Type: str

`friendly_unique_id`^Required

friendly_unique_id: str

Type: str

`terraform_meta_arguments`^Required

terraform_meta_arguments: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`terraform_resource_type`^Required

terraform_resource_type: str

Type: str

`terraform_generator_metadata`^Optional

terraform_generator_metadata: TerraformProviderGeneratorMetadata

Type: TerraformProviderGeneratorMetadata

`connection`^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

Type: SSHProvisionerConnection | WinrmProvisionerConnection

`count`^Optional

count: typing.Union[int, float] | TerraformCount

Type: typing.Union[int, float] | TerraformCount

`depends_on`^Optional

depends_on: typing.List[str]

Type: typing.List[str]

`for_each`^Optional

for_each: ITerraformIterator

Type: ITerraformIterator

`lifecycle`^Optional

lifecycle: TerraformResourceLifecycle

Type: TerraformResourceLifecycle

`provider`^Optional

provider: TerraformProvider

Type: TerraformProvider

`provisioners`^Optional

provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

Type: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner]

`id`^Required

id: str

Type: str

`output`^Required

output: AnyMap

Type: AnyMap

`input_input`^Optional

input_input: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`triggers_replace_input`^Optional

triggers_replace_input: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

`input`^Required

input: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.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

`triggers_replace`^Required

triggers_replace: typing.Mapping[typing.Any]

Type: typing.Mapping[typing.Any]

Constants

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

`tfResourceType`^Required

tfResourceType: str

Type: str

Overview

TypeScript

Python

Java

C#

Go

Documentation Index

​Initializers

​scopeRequired

​idRequired

​connectionOptional

​countOptional

​depends_onOptional

​for_eachOptional

​lifecycleOptional

​providerOptional

​provisionersOptional

​inputOptional

​triggers_replaceOptional

​Methods

​to_string

​add_override

​pathRequired

​valueRequired

​override_logical_id

​new_logical_idRequired

​reset_override_logical_id

​to_hcl_terraform

​to_metadata

​to_terraform

​add_move_target

​move_targetRequired

​get_any_map_attribute

​terraform_attributeRequired

​get_boolean_attribute

​terraform_attributeRequired

​get_boolean_map_attribute

​terraform_attributeRequired

​get_list_attribute

​terraform_attributeRequired

​get_number_attribute

​terraform_attributeRequired

​get_number_list_attribute

​terraform_attributeRequired

​get_number_map_attribute

​terraform_attributeRequired

​get_string_attribute

​terraform_attributeRequired

​get_string_map_attribute

​terraform_attributeRequired

​has_resource_move

​import_from

​idRequired

​providerOptional

​interpolation_for_attribute

​terraform_attributeRequired

​move_from_id

​idRequired

​move_to

​move_targetRequired

​indexOptional

​move_to_id

​idRequired

​reset_input

​reset_triggers_replace

​Static Functions

​is_construct

​xRequired

​is_terraform_element

​xRequired

​is_terraform_resource

​xRequired

​generate_config_for_import

​scopeRequired

​import_to_idRequired

​import_from_idRequired

​providerOptional

​Properties

​nodeRequired

​cdktf_stackRequired

Initializers

`scope`^Required

`id`^Required

`connection`^Optional

`count`^Optional

`depends_on`^Optional

`for_each`^Optional

`lifecycle`^Optional

`provider`^Optional

`provisioners`^Optional

`input`^Optional

`triggers_replace`^Optional

Methods

`to_string`

`add_override`

`path`^Required

`value`^Required

`override_logical_id`

`new_logical_id`^Required

`reset_override_logical_id`

`to_hcl_terraform`

`to_metadata`

`to_terraform`

`add_move_target`

`move_target`^Required

`get_any_map_attribute`

`terraform_attribute`^Required

`get_boolean_attribute`

`terraform_attribute`^Required

`get_boolean_map_attribute`

`terraform_attribute`^Required

`get_list_attribute`

`terraform_attribute`^Required

`get_number_attribute`

`terraform_attribute`^Required

`get_number_list_attribute`

`terraform_attribute`^Required

`get_number_map_attribute`

`terraform_attribute`^Required

`get_string_attribute`

`terraform_attribute`^Required

`get_string_map_attribute`

`terraform_attribute`^Required

`has_resource_move`

`import_from`

`id`^Required

`provider`^Optional

`interpolation_for_attribute`

`terraform_attribute`^Required

`move_from_id`

`id`^Required

`move_to`

`move_target`^Required

`index`^Optional

`move_to_id`

`id`^Required

`reset_input`

`reset_triggers_replace`

Static Functions

`is_construct`

`x`^Required

`is_terraform_element`

`x`^Required

`is_terraform_resource`

`x`^Required

`generate_config_for_import`

`scope`^Required

`import_to_id`^Required

`import_from_id`^Required

`provider`^Optional

Properties

`node`^Required

`cdktf_stack`^Required

`fqn`^Required

`friendly_unique_id`^Required

`terraform_meta_arguments`^Required

`terraform_resource_type`^Required

`terraform_generator_metadata`^Optional

`connection`^Optional

`count`^Optional