Skip to main content

Initializers

import { TerraformVariable } from 'cdktn'

new TerraformVariable(scope: Construct, id: string, config: TerraformVariableConfig)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
configTerraformVariableConfigNo description.

scopeRequired

  • Type: constructs.Construct

idRequired

  • Type: string

configRequired


Methods

NameDescription
toStringReturns a string representation of this construct.
addOverrideNo description.
overrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraformNo description.
toMetadataNo description.
toTerraformNo description.
addValidationNo description.
synthesizeAttributesNo description.
synthesizeHclAttributesNo description.

toString

public toString(): string
Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

pathRequired

  • Type: string

valueRequired

  • Type: any

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.

newLogicalIdRequired

  • Type: string
The new logical ID to use for this stack element.

resetOverrideLogicalId

public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

addValidation

public addValidation(validation: TerraformVariableValidationConfig): void

validationRequired


synthesizeAttributes

public synthesizeAttributes(): {[ key: string ]: any}

synthesizeHclAttributes

public synthesizeHclAttributes(): {[ key: string ]: any}

Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.

isConstruct

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.

xRequired

  • Type: any
Any object.

isTerraformElement

import { TerraformVariable } from 'cdktn'

TerraformVariable.isTerraformElement(x: any)

xRequired

  • Type: any

Properties

NameTypeDescription
nodeconstructs.NodeThe tree node.
cdktfStackTerraformStackNo description.
fqnstringNo description.
friendlyUniqueIdstringNo description.
booleanValueIResolvableNo description.
listValuestring[]No description.
numberValuenumberNo description.
stringValuestringNo description.
valueanyNo description.
defaultanyNo description.
descriptionstringNo description.
nullablebooleanNo description.
sensitivebooleanNo description.
typestringNo description.
validationTerraformVariableValidationConfig[]No description.

nodeRequired

public readonly node: Node;
  • Type: constructs.Node
The tree node.

cdktfStackRequired

public readonly cdktfStack: TerraformStack;

fqnRequired

public readonly fqn: string;
  • Type: string

friendlyUniqueIdRequired

public readonly friendlyUniqueId: string;
  • Type: string

booleanValueRequired

public readonly booleanValue: IResolvable;

listValueRequired

public readonly listValue: string[];
  • Type: string[]

numberValueRequired

public readonly numberValue: number;
  • Type: number

stringValueRequired

public readonly stringValue: string;
  • Type: string

valueRequired

public readonly value: any;
  • Type: any

defaultOptional

public readonly default: any;
  • Type: any

descriptionOptional

public readonly description: string;
  • Type: string

nullableOptional

public readonly nullable: boolean;
  • Type: boolean

sensitiveOptional

public readonly sensitive: boolean;
  • Type: boolean

typeOptional

public readonly type: string;
  • Type: string

validationOptional

public readonly validation: TerraformVariableValidationConfig[];