> ## Documentation Index > Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Python: TerraformResource > CDKTN Core API Reference for TerraformResource in Python. * *Implements:* ITerraformResource, ITerraformDependable, IInterpolatingParent ## Initializers ```python theme={null} import cdktn cdktn.TerraformResource( 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, terraform_resource_type: str, terraform_generator_metadata: TerraformProviderGeneratorMetadata = None ) ``` | **Name** | **Type** | **Description** | | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | scope | constructs.Construct | *No description.* | | id | str | *No description.* | | 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.* | | terraform\_resource\_type | str | *No description.* | | terraform\_generator\_metadata | TerraformProviderGeneratorMetadata | *No description.* | *** ### `scope`^Required * *Type:* constructs.Construct *** ### `id`^Required * *Type:* str *** ### `connection`^Optional * *Type:* SSHProvisionerConnection | WinrmProvisionerConnection *** ### `count`^Optional * *Type:* typing.Union\[int, float] | TerraformCount *** ### `depends_on`^Optional * *Type:* typing.List\[ITerraformDependable] *** ### `for_each`^Optional * *Type:* ITerraformIterator *** ### `lifecycle`^Optional * *Type:* TerraformResourceLifecycle *** ### `provider`^Optional * *Type:* TerraformProvider *** ### `provisioners`^Optional * *Type:* typing.List\[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] *** ### `terraform_resource_type`^Required * *Type:* str *** ### `terraform_generator_metadata`^Optional * *Type:* TerraformProviderGeneratorMetadata *** ## Methods | **Name** | **Description** | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | to\_string | Returns a string representation of this construct. | | with | Applies one or more mixins to 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". | *** ### `to_string` ```python theme={null} def to_string() -> str ``` Returns a string representation of this construct. ### `with` ```python theme={null} def with( mixins: *IMixin ) -> IConstruct ``` Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple `with()` calls if subsequent mixins should apply to added constructs. #### `mixins`^Required * *Type:* \*constructs.IMixin The mixins to apply. *** ### `add_override` ```python theme={null} def add_override( path: str, value: typing.Any ) -> None ``` #### `path`^Required * *Type:* str *** #### `value`^Required * *Type:* typing.Any *** ### `override_logical_id` ```python theme={null} 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` ```python theme={null} def reset_override_logical_id() -> None ``` Resets a previously passed logical Id to use the auto-generated logical id again. ### `to_hcl_terraform` ```python theme={null} def to_hcl_terraform() -> typing.Any ``` ### `to_metadata` ```python theme={null} def to_metadata() -> typing.Any ``` ### `to_terraform` ```python theme={null} def to_terraform() -> typing.Any ``` Adds this resource to the terraform JSON output. ### `add_move_target` ```python theme={null} 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` ```python theme={null} def get_any_map_attribute( terraform_attribute: str ) -> typing.Mapping[typing.Any] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_boolean_attribute` ```python theme={null} def get_boolean_attribute( terraform_attribute: str ) -> IResolvable ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_boolean_map_attribute` ```python theme={null} def get_boolean_map_attribute( terraform_attribute: str ) -> typing.Mapping[bool] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_list_attribute` ```python theme={null} def get_list_attribute( terraform_attribute: str ) -> typing.List[str] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_number_attribute` ```python theme={null} def get_number_attribute( terraform_attribute: str ) -> typing.Union[int, float] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_number_list_attribute` ```python theme={null} def get_number_list_attribute( terraform_attribute: str ) -> typing.List[typing.Union[int, float]] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_number_map_attribute` ```python theme={null} def get_number_map_attribute( terraform_attribute: str ) -> typing.Mapping[typing.Union[int, float]] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_string_attribute` ```python theme={null} def get_string_attribute( terraform_attribute: str ) -> str ``` #### `terraform_attribute`^Required * *Type:* str *** ### `get_string_map_attribute` ```python theme={null} def get_string_map_attribute( terraform_attribute: str ) -> typing.Mapping[str] ``` #### `terraform_attribute`^Required * *Type:* str *** ### `has_resource_move` ```python theme={null} def has_resource_move() -> TerraformResourceMoveByTarget | TerraformResourceMoveById ``` ### `import_from` ```python theme={null} def import_from( id: str, provider: TerraformProvider = None ) -> None ``` #### `id`^Required * *Type:* str *** #### `provider`^Optional * *Type:* TerraformProvider *** ### `interpolation_for_attribute` ```python theme={null} def interpolation_for_attribute( terraform_attribute: str ) -> IResolvable ``` #### `terraform_attribute`^Required * *Type:* str *** ### `move_from_id` ```python theme={null} 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` ```python theme={null} 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` ```python theme={null} 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". *** ## Static Functions | **Name** | **Description** | | ----------------------------------------------------------------------------------------------- | ----------------------------- | | is\_construct | Checks if `x` is a construct. | | is\_terraform\_element | *No description.* | | is\_terraform\_resource | *No description.* | *** ### `is_construct` ```python theme={null} import cdktn cdktn.TerraformResource.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` ```python theme={null} import cdktn cdktn.TerraformResource.is_terraform_element( x: typing.Any ) ``` #### `x`^Required * *Type:* typing.Any *** ### `is_terraform_resource` ```python theme={null} import cdktn cdktn.TerraformResource.is_terraform_resource( x: typing.Any ) ``` #### `x`^Required * *Type:* typing.Any *** ## 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.* | *** ### `node`^Required ```python theme={null} node: Node ``` * *Type:* constructs.Node The tree node. *** ### `cdktf_stack`^Required ```python theme={null} cdktf_stack: TerraformStack ``` * *Type:* TerraformStack *** ### `fqn`^Required ```python theme={null} fqn: str ``` * *Type:* str *** ### `friendly_unique_id`^Required ```python theme={null} friendly_unique_id: str ``` * *Type:* str *** ### `terraform_meta_arguments`^Required ```python theme={null} terraform_meta_arguments: typing.Mapping[typing.Any] ``` * *Type:* typing.Mapping\[typing.Any] *** ### `terraform_resource_type`^Required ```python theme={null} terraform_resource_type: str ``` * *Type:* str *** ### `terraform_generator_metadata`^Optional ```python theme={null} terraform_generator_metadata: TerraformProviderGeneratorMetadata ``` * *Type:* TerraformProviderGeneratorMetadata *** ### `connection`^Optional ```python theme={null} connection: SSHProvisionerConnection | WinrmProvisionerConnection ``` * *Type:* SSHProvisionerConnection | WinrmProvisionerConnection *** ### `count`^Optional ```python theme={null} count: typing.Union[int, float] | TerraformCount ``` * *Type:* typing.Union\[int, float] | TerraformCount *** ### `depends_on`^Optional ```python theme={null} depends_on: typing.List[str] ``` * *Type:* typing.List\[str] *** ### `for_each`^Optional ```python theme={null} for_each: ITerraformIterator ``` * *Type:* ITerraformIterator *** ### `lifecycle`^Optional ```python theme={null} lifecycle: TerraformResourceLifecycle ``` * *Type:* TerraformResourceLifecycle *** ### `provider`^Optional ```python theme={null} provider: TerraformProvider ``` * *Type:* TerraformProvider *** ### `provisioners`^Optional ```python theme={null} provisioners: typing.List[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] ``` * *Type:* typing.List\[FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner] ***