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.

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 "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.NewTerraformModule(scope Construct, id *string, options TerraformModuleConfig) TerraformModule
NameTypeDescription
scopegithub.com/aws/constructs-go/constructs/v10.ConstructNo description.
id*stringNo description.
optionsTerraformModuleConfigNo description.

​
scopeRequired

  • Type: github.com/aws/constructs-go/constructs/v10.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.

​
ToString 

func ToString() *string
Returns a string representation of this construct.

​
AddOverride 

func AddOverride(path *string, value interface{})

​
pathRequired

  • Type: *string

​
valueRequired

  • Type: interface{}

​
OverrideLogicalId 

func OverrideLogicalId(newLogicalId *string)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • Type: *string
The new logical ID to use for this stack element.

​
ResetOverrideLogicalId 

func ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.

​
ToHclTerraform 

func ToHclTerraform() interface{}

​
ToMetadata 

func ToMetadata() interface{}

​
ToTerraform 

func ToTerraform() interface{}

​
AddProvider 

func AddProvider(provider interface{})

​
providerRequired

  • Type: interface{}

​
GetString 

func GetString(output *string) *string

​
outputRequired

  • Type: *string

​
InterpolationForOutput 

func InterpolationForOutput(moduleOutput *string) IResolvable

​
moduleOutputRequired

  • Type: *string

​
Static Functions

NameDescription
IsConstructChecks if x is a construct.
IsTerraformElementNo description.

​
IsConstruct 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.TerraformModule_IsConstruct(x interface{}) *bool
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: interface{}
Any object.

​
IsTerraformElement 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.TerraformModule_IsTerraformElement(x interface{}) *bool

​
xRequired

  • Type: interface{}

​
Properties

NameTypeDescription
Nodegithub.com/aws/constructs-go/constructs/v10.NodeThe tree node.
CdktfStackTerraformStackNo description.
Fqn*stringNo description.
FriendlyUniqueId*stringNo description.
Source*stringNo description.
Providers*[]interface{}No description.
SkipAssetCreationFromLocalModules*boolNo description.
Version*stringNo description.
DependsOn*[]*stringNo description.
ForEachITerraformIteratorNo description.

​
NodeRequired 

func Node() Node
  • Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.

​
CdktfStackRequired 

func CdktfStack() TerraformStack

​
FqnRequired 

func Fqn() *string
  • Type: *string

​
FriendlyUniqueIdRequired 

func FriendlyUniqueId() *string
  • Type: *string

​
SourceRequired 

func Source() *string
  • Type: *string

​
ProvidersOptional 

func Providers() *[]interface{}
  • Type: *[]interface{}

​
SkipAssetCreationFromLocalModulesOptional 

func SkipAssetCreationFromLocalModules() *bool
  • Type: *bool

​
VersionOptional 

func Version() *string
  • Type: *string

​
DependsOnOptional 

func DependsOn() *[]*string
  • Type: *[]*string

​
ForEachOptional 

func ForEach() ITerraformIterator