CSharp: 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

using Io.Cdktn;

new TerraformModule(Construct Scope, string Id, TerraformModuleConfig Options);

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`

private string ToString()

Returns a string representation of this construct.

`AddOverride`

private void AddOverride(string Path, object Value)

`Path`^Required

Type: string

`Value`^Required

Type: object

`OverrideLogicalId`

private void OverrideLogicalId(string NewLogicalId)

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`

private void ResetOverrideLogicalId()

Resets a previously passed logical Id to use the auto-generated logical id again.

`ToHclTerraform`

private object ToHclTerraform()

`ToMetadata`

private object ToMetadata()

`ToTerraform`

private object ToTerraform()

`AddProvider`

private void AddProvider(TerraformProvider|TerraformModuleProvider Provider)

`Provider`^Required

Type: TerraformProvider|TerraformModuleProvider

`GetString`

private string GetString(string Output)

`Output`^Required

Type: string

`InterpolationForOutput`

private IResolvable InterpolationForOutput(string ModuleOutput)

`ModuleOutput`^Required

Type: string

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.

`IsConstruct`

using Io.Cdktn;

TerraformModule.IsConstruct(object X);

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: object

Any object.

`IsTerraformElement`

using Io.Cdktn;

TerraformModule.IsTerraformElement(object X);

`X`^Required

Type: object

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`	`bool`	No description.
`Version`	`string`	No description.
`DependsOn`	`string[]`	No description.
`ForEach`	`ITerraformIterator`	No description.

`Node`^Required

public Node Node { get; }

Type: Constructs.Node

The tree node.

`CdktfStack`^Required

public TerraformStack CdktfStack { get; }

Type: TerraformStack

`Fqn`^Required

public string Fqn { get; }

Type: string

`FriendlyUniqueId`^Required

public string FriendlyUniqueId { get; }

Type: string

`Source`^Required

public string Source { get; }

Type: string

`Providers`^Optional

public (TerraformProvider|TerraformModuleProvider)[] Providers { get; }

Type: TerraformProvider|TerraformModuleProvider[]

`SkipAssetCreationFromLocalModules`^Optional

public bool SkipAssetCreationFromLocalModules { get; }

Type: bool

`Version`^Optional

public string Version { get; }

Type: string

`DependsOn`^Optional

public string[] DependsOn { get; }

Type: string[]

`ForEach`^Optional

public ITerraformIterator ForEach { get; }

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