> ## 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: TerraformVariable > CDKTN Core API Reference for TerraformVariable in Typescript. * *Implements:* ITerraformAddressable ## Initializers ```typescript theme={null} import { TerraformVariable } from 'cdktn' new TerraformVariable(scope: Construct, id: string, config: TerraformVariableConfig) ``` | **Name** | **Type** | **Description** | | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ----------------- | | scope | constructs.Construct | *No description.* | | id | string | *No description.* | | config | TerraformVariableConfig | *No description.* | *** ### `scope`^Required * *Type:* constructs.Construct *** ### `id`^Required * *Type:* string *** ### `config`^Required * *Type:* TerraformVariableConfig *** ## 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.* | | addValidation | *No description.* | | synthesizeAttributes | *No description.* | | synthesizeHclAttributes | *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 ``` ### `addValidation` ```typescript theme={null} public addValidation(validation: TerraformVariableValidationConfig): void ``` #### `validation`^Required * *Type:* TerraformVariableValidationConfig *** ### `synthesizeAttributes` ```typescript theme={null} public synthesizeAttributes(): {[ key: string ]: any} ``` ### `synthesizeHclAttributes` ```typescript theme={null} public synthesizeHclAttributes(): {[ key: string ]: any} ``` ## Static Functions | **Name** | **Description** | | ----------------------------------------------------------------------------------------- | ----------------------------- | | isConstruct | Checks if `x` is a construct. | | isTerraformElement | *No description.* | *** ### `isConstruct` ```typescript theme={null} import { TerraformVariable } from 'cdktn' TerraformVariable.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 { TerraformVariable } from 'cdktn' TerraformVariable.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.* | | booleanValue | IResolvable | *No description.* | | listValue | string\[] | *No description.* | | numberValue | number | *No description.* | | stringValue | string | *No description.* | | value | any | *No description.* | | default | any | *No description.* | | description | string | *No description.* | | nullable | boolean | *No description.* | | sensitive | boolean | *No description.* | | type | string | *No description.* | | validation | TerraformVariableValidationConfig\[] | *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 *** ### `booleanValue`^Required ```typescript theme={null} public readonly booleanValue: IResolvable; ``` * *Type:* IResolvable *** ### `listValue`^Required ```typescript theme={null} public readonly listValue: string[]; ``` * *Type:* string\[] *** ### `numberValue`^Required ```typescript theme={null} public readonly numberValue: number; ``` * *Type:* number *** ### `stringValue`^Required ```typescript theme={null} public readonly stringValue: string; ``` * *Type:* string *** ### `value`^Required ```typescript theme={null} public readonly value: any; ``` * *Type:* any *** ### `default`^Optional ```typescript theme={null} public readonly default: any; ``` * *Type:* any *** ### `description`^Optional ```typescript theme={null} public readonly description: string; ``` * *Type:* string *** ### `nullable`^Optional ```typescript theme={null} public readonly nullable: boolean; ``` * *Type:* boolean *** ### `sensitive`^Optional ```typescript theme={null} public readonly sensitive: boolean; ``` * *Type:* boolean *** ### `type`^Optional ```typescript theme={null} public readonly type: string; ``` * *Type:* string *** ### `validation`^Optional ```typescript theme={null} public readonly validation: TerraformVariableValidationConfig[]; ``` * *Type:* TerraformVariableValidationConfig\[] ***