Skip to main content

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.

​
Initializers 

import io.cdktn.cdktn.TerraformHclModule;

TerraformHclModule.Builder.create(Construct scope, java.lang.String id)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .providers(java.util.List<TerraformProvider|TerraformModuleProvider>)
//  .skipAssetCreationFromLocalModules(java.lang.Boolean)
    .source(java.lang.String)
//  .version(java.lang.String)
//  .variables(java.util.Map<java.lang.String, java.lang.Object>)
    .build();
NameTypeDescription
scopesoftware.constructs.ConstructNo description.
idjava.lang.StringNo description.
dependsOnjava.util.List<ITerraformDependable>No description.
forEachITerraformIteratorNo description.
providersjava.util.List<TerraformProvider|TerraformModuleProvider>No description.
skipAssetCreationFromLocalModulesjava.lang.BooleanNo description.
sourcejava.lang.StringNo description.
versionjava.lang.StringNo description.
variablesjava.util.Map< java.lang.String, java.lang.Object >No description.

​
scopeRequired

  • Type: software.constructs.Construct

​
idRequired

  • Type: java.lang.String

​
dependsOnOptional

​
forEachOptional

​
providersOptional

​
skipAssetCreationFromLocalModulesOptional

  • Type: java.lang.Boolean

​
sourceRequired

  • Type: java.lang.String

​
versionOptional

  • Type: java.lang.String

​
variablesOptional

  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
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 

public java.lang.String toString()
Returns a string representation of this construct.

​
addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

​
pathRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • Type: java.lang.String
The new logical ID to use for this stack element.

​
resetOverrideLogicalId 

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

​
toHclTerraform 

public java.lang.Object toHclTerraform()

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

public java.lang.Object toTerraform()

​
addProvider 

public void addProvider(TerraformProvider|TerraformModuleProvider provider)

​
providerRequired

​
getString 

public java.lang.String getString(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
interpolationForOutput 

public IResolvable interpolationForOutput(java.lang.String moduleOutput)

​
moduleOutputRequired

  • Type: java.lang.String

​
get 

public java.lang.Object get(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getBoolean 

public IResolvable getBoolean(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getList 

public java.util.List<java.lang.String> getList(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getNumber 

public java.lang.Number getNumber(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
set 

public void set(java.lang.String variable, java.lang.Object value)

​
variableRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.

​
isConstruct 

import io.cdktn.cdktn.TerraformHclModule;

TerraformHclModule.isConstruct(java.lang.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: java.lang.Object
Any object.

​
isTerraformElement 

import io.cdktn.cdktn.TerraformHclModule;

TerraformHclModule.isTerraformElement(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
Properties

NameTypeDescription
nodesoftware.constructs.NodeThe tree node.
cdktfStackTerraformStackNo description.
fqnjava.lang.StringNo description.
friendlyUniqueIdjava.lang.StringNo description.
sourcejava.lang.StringNo description.
providersjava.util.List<TerraformProvider|TerraformModuleProvider>No description.
skipAssetCreationFromLocalModulesjava.lang.BooleanNo description.
versionjava.lang.StringNo description.
dependsOnjava.util.List< java.lang.String >No description.
forEachITerraformIteratorNo description.
variablesjava.util.Map< java.lang.String, java.lang.Object >No description.

​
nodeRequired 

public Node getNode();
  • Type: software.constructs.Node
The tree node.

​
cdktfStackRequired 

public TerraformStack getCdktfStack();

​
fqnRequired 

public java.lang.String getFqn();
  • Type: java.lang.String

​
friendlyUniqueIdRequired 

public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String

​
sourceRequired 

public java.lang.String getSource();
  • Type: java.lang.String

​
providersOptional 

public java.util.List<TerraformProvider|TerraformModuleProvider> getProviders();

​
skipAssetCreationFromLocalModulesOptional 

public java.lang.Boolean getSkipAssetCreationFromLocalModules();
  • Type: java.lang.Boolean

​
versionOptional 

public java.lang.String getVersion();
  • Type: java.lang.String

​
dependsOnOptional 

public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List< java.lang.String >

​
forEachOptional 

public ITerraformIterator getForEach();

​
variablesOptional 

public java.util.Map<java.lang.String, java.lang.Object> getVariables();
  • Type: java.util.Map< java.lang.String, java.lang.Object >