Skip to main content

Initializers

using Io.Cdktn;

new TerraformHclModule(Construct Scope, string Id, TerraformHclModuleConfig Options);
NameTypeDescription
ScopeConstructs.ConstructNo description.
IdstringNo description.
OptionsTerraformHclModuleConfigNo description.

ScopeRequired

  • Type: Constructs.Construct

IdRequired

  • Type: string

OptionsRequired


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.
AddProviderNo description.
GetStringNo description.
InterpolationForOutputNo description.
GetNo description.
GetBooleanNo description.
GetListNo description.
GetNumberNo description.
SetNo description.

ToString

private string ToString()
Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

PathRequired

  • Type: string

ValueRequired

  • Type: object

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired

  • 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)

ProviderRequired


GetString

private string GetString(string Output)

OutputRequired

  • Type: string

InterpolationForOutput

private IResolvable InterpolationForOutput(string ModuleOutput)

ModuleOutputRequired

  • Type: string

Get

private object Get(string Output)

OutputRequired

  • Type: string

GetBoolean

private IResolvable GetBoolean(string Output)

OutputRequired

  • Type: string

GetList

private string[] GetList(string Output)

OutputRequired

  • Type: string

GetNumber

private double GetNumber(string Output)

OutputRequired

  • Type: string

Set

private void Set(string Variable, object Value)

VariableRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

NameDescription
IsConstructChecks if x is a construct.
IsTerraformElementNo description.

IsConstruct

using Io.Cdktn;

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

XRequired

  • Type: object
Any object.

IsTerraformElement

using Io.Cdktn;

TerraformHclModule.IsTerraformElement(object X);

XRequired

  • Type: object

Properties

NameTypeDescription
NodeConstructs.NodeThe tree node.
CdktfStackTerraformStackNo description.
FqnstringNo description.
FriendlyUniqueIdstringNo description.
SourcestringNo description.
ProvidersTerraformProvider|TerraformModuleProvider[]No description.
SkipAssetCreationFromLocalModulesboolNo description.
VersionstringNo description.
DependsOnstring[]No description.
ForEachITerraformIteratorNo description.
VariablesSystem.Collections.Generic.IDictionary< string, object >No description.

NodeRequired

public Node Node { get; }
  • Type: Constructs.Node
The tree node.

CdktfStackRequired

public TerraformStack CdktfStack { get; }

FqnRequired

public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired

public string FriendlyUniqueId { get; }
  • Type: string

SourceRequired

public string Source { get; }
  • Type: string

ProvidersOptional

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

SkipAssetCreationFromLocalModulesOptional

public bool SkipAssetCreationFromLocalModules { get; }
  • Type: bool

VersionOptional

public string Version { get; }
  • Type: string

DependsOnOptional

public string[] DependsOn { get; }
  • Type: string[]

ForEachOptional

public ITerraformIterator ForEach { get; }

VariablesOptional

public System.Collections.Generic.IDictionary<string, object> Variables { get; }
  • Type: System.Collections.Generic.IDictionary< string, object >