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
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. |
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
private string ToString()
AddOverride
private void AddOverride(string Path, object Value)
PathRequired
ValueRequired
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
NewLogicalIdRequired
The new logical ID to use for this stack element.
ResetOverrideLogicalId
private void ResetOverrideLogicalId()
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
AddProvider
private void AddProvider(TerraformProvider|TerraformModuleProvider Provider)
ProviderRequired
GetString
private string GetString(string Output)
OutputRequired
InterpolationForOutput
private IResolvable InterpolationForOutput(string ModuleOutput)
ModuleOutputRequired
Static Functions
| Name | Description |
|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using Io.Cdktn;
TerraformModule.IsConstruct(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.
using Io.Cdktn;
TerraformModule.IsTerraformElement(object X);
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 | bool | No description. |
Version | string | No description. |
DependsOn | string[] | No description. |
ForEach | ITerraformIterator | No description. |
NodeRequired
public Node Node { get; }
CdktfStackRequired
public TerraformStack CdktfStack { get; }
FqnRequired
public string Fqn { get; }
FriendlyUniqueIdRequired
public string FriendlyUniqueId { get; }
SourceRequired
public string Source { get; }
ProvidersOptional
public (TerraformProvider|TerraformModuleProvider)[] Providers { get; }
SkipAssetCreationFromLocalModulesOptional
public bool SkipAssetCreationFromLocalModules { get; }
VersionOptional
public string Version { get; }
DependsOnOptional
public string[] DependsOn { get; }
ForEachOptional
public ITerraformIterator ForEach { get; }
