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 io.cdktn.cdktn.TerraformModule;
TerraformModule.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)
.build();
| Name | Type | Description |
|---|
scope | software.constructs.Construct | No description. |
id | java.lang.String | No description. |
dependsOn | java.util.List<ITerraformDependable> | No description. |
forEach | ITerraformIterator | No description. |
providers | java.util.List<TerraformProvider|TerraformModuleProvider> | No description. |
skipAssetCreationFromLocalModules | java.lang.Boolean | No description. |
source | java.lang.String | No description. |
version | java.lang.String | No description. |
scopeRequired
- Type: software.constructs.Construct
idRequired
dependsOnOptional
forEachOptional
providersOptional
skipAssetCreationFromLocalModulesOptional
sourceRequired
versionOptional
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 java.lang.String toString()
addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
valueRequired
overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)
newLogicalIdRequired
The new logical ID to use for this stack element.
resetOverrideLogicalId
public void resetOverrideLogicalId()
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
addProvider
public void addProvider(TerraformProvider|TerraformModuleProvider provider)
providerRequired
getString
public java.lang.String getString(java.lang.String output)
outputRequired
interpolationForOutput
public IResolvable interpolationForOutput(java.lang.String moduleOutput)
moduleOutputRequired
Static Functions
| Name | Description |
|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import io.cdktn.cdktn.TerraformModule;
TerraformModule.isConstruct(java.lang.Object x)
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 io.cdktn.cdktn.TerraformModule;
TerraformModule.isTerraformElement(java.lang.Object x)
xRequired
Properties
| Name | Type | Description |
|---|
node | software.constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | java.lang.String | No description. |
friendlyUniqueId | java.lang.String | No description. |
source | java.lang.String | No description. |
providers | java.util.List<TerraformProvider|TerraformModuleProvider> | No description. |
skipAssetCreationFromLocalModules | java.lang.Boolean | No description. |
version | java.lang.String | No description. |
dependsOn | java.util.List< java.lang.String > | No description. |
forEach | ITerraformIterator | No description. |
nodeRequired
- Type: software.constructs.Node
The tree node.
cdktfStackRequired
public TerraformStack getCdktfStack();
fqnRequired
public java.lang.String getFqn();
friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
sourceRequired
public java.lang.String getSource();
providersOptional
public java.util.List<TerraformProvider|TerraformModuleProvider> getProviders();
skipAssetCreationFromLocalModulesOptional
public java.lang.Boolean getSkipAssetCreationFromLocalModules();
versionOptional
public java.lang.String getVersion();
dependsOnOptional
public java.util.List<java.lang.String> getDependsOn();
- Type: java.util.List< java.lang.String >
forEachOptional
public ITerraformIterator getForEach();
