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.
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. |
scopeRequired
- Type: constructs.Construct
idRequired
optionsRequired
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
addOverride
public addOverride(path: string, value: any): void
pathRequired
valueRequired
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
newLogicalIdRequired
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
public toHclTerraform(): any
public toTerraform(): any
addProvider
public addProvider(provider: TerraformProvider | TerraformModuleProvider): void
providerRequired
getString
public getString(output: string): string
outputRequired
interpolationForOutput
public interpolationForOutput(moduleOutput: string): IResolvable
moduleOutputRequired
Static Functions
| Name | Description |
|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformModule } from 'cdktn'
TerraformModule.isConstruct(x: any)
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
Any object.
import { TerraformModule } from 'cdktn'
TerraformModule.isTerraformElement(x: any)
xRequired
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. |
nodeRequired
public readonly node: Node;
cdktfStackRequired
public readonly cdktfStack: TerraformStack;
fqnRequired
public readonly fqn: string;
friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
sourceRequired
public readonly source: string;
providersOptional
public readonly providers: (TerraformProvider | TerraformModuleProvider)[];
skipAssetCreationFromLocalModulesOptional
public readonly skipAssetCreationFromLocalModules: boolean;
versionOptional
public readonly version: string;
dependsOnOptional
public readonly dependsOn: string[];
forEachOptional
public readonly forEach: ITerraformIterator;
