Typescript: TerraformModule - CDK Terrain (CDKTN)

Implements: ITerraformDependable

TerraformModule can be used to reference a local terraform module or a module from the Terraform Registry. It should be used if you can not use generated bindings for the module as you would get by adding the module to your cdktf.json files “terraformModules” array and running cdktn get. This class is not creating a Terraform module to be used outside of CDKTN. If you want to bundle certain resources together like you would do with a Terraform module, you should use Constructs instead, see http://cdk.tf/constructs for more details.

Initializers

import { TerraformModule } from 'cdktn'

new TerraformModule(scope: Construct, id: string, options: TerraformModuleConfig)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`string`	No description.
`options`	`TerraformModuleConfig`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: string

`options`^Required

Type: TerraformModuleConfig

Methods

Name	Description
`toString`	Returns a string representation of 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.

`toString`

public toString(): string

Returns a string representation of this construct.

`addOverride`

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

`path`^Required

Type: string

`value`^Required

Type: any

`overrideLogicalId`

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`

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

`addProvider`

public addProvider(provider: TerraformProvider | TerraformModuleProvider): void

`provider`^Required

Type: TerraformProvider | TerraformModuleProvider

`getString`

public getString(output: string): string

`output`^Required

Type: string

`interpolationForOutput`

public interpolationForOutput(moduleOutput: string): IResolvable

`moduleOutput`^Required

Type: string

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.

`isConstruct`

import { TerraformModule } from 'cdktn'

TerraformModule.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`

import { TerraformModule } from 'cdktn'

TerraformModule.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.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`cdktfStack`^Required

public readonly cdktfStack: TerraformStack;

Type: TerraformStack

`fqn`^Required

public readonly fqn: string;

Type: string

`friendlyUniqueId`^Required

public readonly friendlyUniqueId: string;

Type: string

`source`^Required

public readonly source: string;

Type: string

`providers`^Optional

public readonly providers: (TerraformProvider | TerraformModuleProvider)[];

Type: TerraformProvider | TerraformModuleProvider[]

`skipAssetCreationFromLocalModules`^Optional

public readonly skipAssetCreationFromLocalModules: boolean;

Type: boolean

`version`^Optional

public readonly version: string;

Type: string

`dependsOn`^Optional

public readonly dependsOn: string[];

Type: string[]

`forEach`^Optional

public readonly forEach: ITerraformIterator;

Type: ITerraformIterator

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​scopeRequired

​idRequired

​optionsRequired

​Methods

​toString

​addOverride

​pathRequired

​valueRequired

​overrideLogicalId

​newLogicalIdRequired

​resetOverrideLogicalId

​toHclTerraform

​toMetadata

​toTerraform

​addProvider

​providerRequired

​getString

​outputRequired

​interpolationForOutput

​moduleOutputRequired

​Static Functions

​isConstruct

​xRequired

​isTerraformElement

​xRequired

​Properties

​nodeRequired

​cdktfStackRequired

​fqnRequired

​friendlyUniqueIdRequired

​sourceRequired

​providersOptional

​skipAssetCreationFromLocalModulesOptional

​versionOptional

​dependsOnOptional

​forEachOptional

Initializers

`scope`^Required

`id`^Required

`options`^Required

Methods

`toString`

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`addProvider`

`provider`^Required

`getString`

`output`^Required

`interpolationForOutput`

`moduleOutput`^Required

Static Functions

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

Properties

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required

`source`^Required

`providers`^Optional

`skipAssetCreationFromLocalModules`^Optional

`version`^Optional

`dependsOn`^Optional

`forEach`^Optional