> ## 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. # Typescript: TerraformHclModule > CDKTN Core API Reference for TerraformHclModule in Typescript. ## Initializers ```typescript theme={null} import { TerraformHclModule } from 'cdktn' new TerraformHclModule(scope: Construct, id: string, options: TerraformHclModuleConfig) ``` | **Name** | **Type** | **Description** | | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | ----------------- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | options | TerraformHclModuleConfig | *No description.* | *** ### `scope`^Required * *Type:* constructs.Construct *** ### `id`^Required * *Type:* string *** ### `options`^Required * *Type:* TerraformHclModuleConfig *** ## Methods | **Name** | **Description** | | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | toString | Returns a string representation of this construct. | | with | Applies one or more mixins to 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 | *No description.* | | addProvider | *No description.* | | getString | *No description.* | | interpolationForOutput | *No description.* | | get | *No description.* | | getBoolean | *No description.* | | getList | *No description.* | | getNumber | *No description.* | | set | *No description.* | *** ### `toString` ```typescript theme={null} public toString(): string ``` Returns a string representation of this construct. ### `with` ```typescript theme={null} public 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. *** ### `addOverride` ```typescript theme={null} public addOverride(path: string, value: any): void ``` #### `path`^Required * *Type:* string *** #### `value`^Required * *Type:* any *** ### `overrideLogicalId` ```typescript theme={null} 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` ```typescript theme={null} public resetOverrideLogicalId(): void ``` Resets a previously passed logical Id to use the auto-generated logical id again. ### `toHclTerraform` ```typescript theme={null} public toHclTerraform(): any ``` ### `toMetadata` ```typescript theme={null} public toMetadata(): any ``` ### `toTerraform` ```typescript theme={null} public toTerraform(): any ``` ### `addProvider` ```typescript theme={null} public addProvider(provider: TerraformProvider | TerraformModuleProvider): void ``` #### `provider`^Required * *Type:* TerraformProvider | TerraformModuleProvider *** ### `getString` ```typescript theme={null} public getString(output: string): string ``` #### `output`^Required * *Type:* string *** ### `interpolationForOutput` ```typescript theme={null} public interpolationForOutput(moduleOutput: string): IResolvable ``` #### `moduleOutput`^Required * *Type:* string *** ### `get` ```typescript theme={null} public get(output: string): any ``` #### `output`^Required * *Type:* string *** ### `getBoolean` ```typescript theme={null} public getBoolean(output: string): IResolvable ``` #### `output`^Required * *Type:* string *** ### `getList` ```typescript theme={null} public getList(output: string): string[] ``` #### `output`^Required * *Type:* string *** ### `getNumber` ```typescript theme={null} public getNumber(output: string): number ``` #### `output`^Required * *Type:* string *** ### `set` ```typescript theme={null} public set(variable: string, value: any): void ``` #### `variable`^Required * *Type:* string *** #### `value`^Required * *Type:* any *** ## Static Functions | **Name** | **Description** | | ------------------------------------------------------------------------------------------ | ----------------------------- | | isConstruct | Checks if `x` is a construct. | | isTerraformElement | *No description.* | *** ### `isConstruct` ```typescript theme={null} import { TerraformHclModule } from 'cdktn' TerraformHclModule.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` ```typescript theme={null} import { TerraformHclModule } from 'cdktn' TerraformHclModule.isTerraformElement(x: any) ``` #### `x`^Required * *Type:* any *** ## Properties | **Name** | **Type** | **Description** | | --------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------- | | node | constructs.Node | The tree node. | | cdktfStack | TerraformStack | *No description.* | | fqn | string | *No description.* | | friendlyUniqueId | string | *No description.* | | source | string | *No description.* | | providers | TerraformProvider \| TerraformModuleProvider\[] | *No description.* | | skipAssetCreationFromLocalModules | boolean | *No description.* | | version | string | *No description.* | | dependsOn | string\[] | *No description.* | | forEach | ITerraformIterator | *No description.* | | variables | \{\[ key: string ]: any} | *No description.* | *** ### `node`^Required ```typescript theme={null} public readonly node: Node; ``` * *Type:* constructs.Node The tree node. *** ### `cdktfStack`^Required ```typescript theme={null} public readonly cdktfStack: TerraformStack; ``` * *Type:* TerraformStack *** ### `fqn`^Required ```typescript theme={null} public readonly fqn: string; ``` * *Type:* string *** ### `friendlyUniqueId`^Required ```typescript theme={null} public readonly friendlyUniqueId: string; ``` * *Type:* string *** ### `source`^Required ```typescript theme={null} public readonly source: string; ``` * *Type:* string *** ### `providers`^Optional ```typescript theme={null} public readonly providers: (TerraformProvider | TerraformModuleProvider)[]; ``` * *Type:* TerraformProvider | TerraformModuleProvider\[] *** ### `skipAssetCreationFromLocalModules`^Optional ```typescript theme={null} public readonly skipAssetCreationFromLocalModules: boolean; ``` * *Type:* boolean *** ### `version`^Optional ```typescript theme={null} public readonly version: string; ``` * *Type:* string *** ### `dependsOn`^Optional ```typescript theme={null} public readonly dependsOn: string[]; ``` * *Type:* string\[] *** ### `forEach`^Optional ```typescript theme={null} public readonly forEach: ITerraformIterator; ``` * *Type:* ITerraformIterator *** ### `variables`^Optional ```typescript theme={null} public readonly variables: {[ key: string ]: any}; ``` * *Type:* \{\[ key: string ]: any} ***