> ## 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: TerraformHclModule > CDKTN Core API Reference for TerraformHclModule in Python. ## Initializers ```python theme={null} import cdktn cdktn.TerraformHclModule( scope: Construct, id: str, depends_on: typing.List[ITerraformDependable] = None, for_each: ITerraformIterator = None, providers: typing.List[TerraformProvider | TerraformModuleProvider] = None, skip_asset_creation_from_local_modules: bool = None, source: str, version: str = None, variables: typing.Mapping[typing.Any] = None ) ``` | **Name** | **Type** | **Description** | | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- | | scope | constructs.Construct | *No description.* | | id | str | *No description.* | | depends\_on | typing.List\[ITerraformDependable] | *No description.* | | for\_each | ITerraformIterator | *No description.* | | providers | typing.List\[TerraformProvider \| TerraformModuleProvider] | *No description.* | | skip\_asset\_creation\_from\_local\_modules | bool | *No description.* | | source | str | *No description.* | | version | str | *No description.* | | variables | typing.Mapping\[typing.Any] | *No description.* | *** ### `scope`^Required * *Type:* constructs.Construct *** ### `id`^Required * *Type:* str *** ### `depends_on`^Optional * *Type:* typing.List\[ITerraformDependable] *** ### `for_each`^Optional * *Type:* ITerraformIterator *** ### `providers`^Optional * *Type:* typing.List\[TerraformProvider | TerraformModuleProvider] *** ### `skip_asset_creation_from_local_modules`^Optional * *Type:* bool *** ### `source`^Required * *Type:* str *** ### `version`^Optional * *Type:* str *** ### `variables`^Optional * *Type:* typing.Mapping\[typing.Any] *** ## 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 | *No description.* | | add\_provider | *No description.* | | get\_string | *No description.* | | interpolation\_for\_output | *No description.* | | get | *No description.* | | get\_boolean | *No description.* | | get\_list | *No description.* | | get\_number | *No description.* | | set | *No description.* | *** ### `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 ``` ### `add_provider` ```python theme={null} def add_provider( provider: TerraformProvider | TerraformModuleProvider ) -> None ``` #### `provider`^Required * *Type:* TerraformProvider | TerraformModuleProvider *** ### `get_string` ```python theme={null} def get_string( output: str ) -> str ``` #### `output`^Required * *Type:* str *** ### `interpolation_for_output` ```python theme={null} def interpolation_for_output( module_output: str ) -> IResolvable ``` #### `module_output`^Required * *Type:* str *** ### `get` ```python theme={null} def get( output: str ) -> typing.Any ``` #### `output`^Required * *Type:* str *** ### `get_boolean` ```python theme={null} def get_boolean( output: str ) -> IResolvable ``` #### `output`^Required * *Type:* str *** ### `get_list` ```python theme={null} def get_list( output: str ) -> typing.List[str] ``` #### `output`^Required * *Type:* str *** ### `get_number` ```python theme={null} def get_number( output: str ) -> typing.Union[int, float] ``` #### `output`^Required * *Type:* str *** ### `set` ```python theme={null} def set( variable: str, value: typing.Any ) -> None ``` #### `variable`^Required * *Type:* str *** #### `value`^Required * *Type:* typing.Any *** ## Static Functions | **Name** | **Description** | | ---------------------------------------------------------------------------------------------- | ----------------------------- | | is\_construct | Checks if `x` is a construct. | | is\_terraform\_element | *No description.* | *** ### `is_construct` ```python theme={null} import cdktn cdktn.TerraformHclModule.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.TerraformHclModule.is_terraform_element( 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.* | | source | str | *No description.* | | providers | typing.List\[TerraformProvider \| TerraformModuleProvider] | *No description.* | | skip\_asset\_creation\_from\_local\_modules | bool | *No description.* | | version | str | *No description.* | | depends\_on | typing.List\[str] | *No description.* | | for\_each | ITerraformIterator | *No description.* | | variables | typing.Mapping\[typing.Any] | *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 *** ### `source`^Required ```python theme={null} source: str ``` * *Type:* str *** ### `providers`^Optional ```python theme={null} providers: typing.List[TerraformProvider | TerraformModuleProvider] ``` * *Type:* typing.List\[TerraformProvider | TerraformModuleProvider] *** ### `skip_asset_creation_from_local_modules`^Optional ```python theme={null} skip_asset_creation_from_local_modules: bool ``` * *Type:* bool *** ### `version`^Optional ```python theme={null} version: str ``` * *Type:* str *** ### `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 *** ### `variables`^Optional ```python theme={null} variables: typing.Mapping[typing.Any] ``` * *Type:* typing.Mapping\[typing.Any] ***