Go: TerraformHclModule - CDK Terrain (CDKTN)

Initializers

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

cdktn.NewTerraformHclModule(scope Construct, id *string, options TerraformHclModuleConfig) TerraformHclModule

Name	Type	Description
`scope`	`github.com/aws/constructs-go/constructs/v10.Construct`	No description.
`id`	`*string`	No description.
`options`	`TerraformHclModuleConfig`	No description.

`scope`^Required

Type: github.com/aws/constructs-go/constructs/v10.Construct

`id`^Required

Type: *string

`options`^Required

Type: TerraformHclModuleConfig

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.
`Get`	No description.
`GetBoolean`	No description.
`GetList`	No description.
`GetNumber`	No description.
`Set`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`AddOverride`

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

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`OverrideLogicalId`

func OverrideLogicalId(newLogicalId *string)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

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{})

`provider`^Required

Type: interface{}

`GetString`

func GetString(output *string) *string

`output`^Required

Type: *string

`InterpolationForOutput`

func InterpolationForOutput(moduleOutput *string) IResolvable

`moduleOutput`^Required

Type: *string

`Get`

func Get(output *string) interface{}

`output`^Required

Type: *string

`GetBoolean`

func GetBoolean(output *string) IResolvable

`output`^Required

Type: *string

`GetList`

func GetList(output *string) *[]*string

`output`^Required

Type: *string

`GetNumber`

func GetNumber(output *string) *f64

`output`^Required

Type: *string

`Set`

func Set(variable *string, value interface{})

`variable`^Required

Type: *string

`value`^Required

Type: interface{}

Static Functions

Name	Description
`IsConstruct`	Checks if `x` is a construct.
`IsTerraformElement`	No description.

`IsConstruct`

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

cdktn.TerraformHclModule_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.

`x`^Required

Type: interface{}

Any object.

`IsTerraformElement`

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

cdktn.TerraformHclModule_IsTerraformElement(x interface{}) *bool

`x`^Required

Type: interface{}

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`CdktfStack`	`TerraformStack`	No description.
`Fqn`	`*string`	No description.
`FriendlyUniqueId`	`*string`	No description.
`Source`	`*string`	No description.
`Providers`	`*[]interface{}`	No description.
`SkipAssetCreationFromLocalModules`	`*bool`	No description.
`Version`	`*string`	No description.
`DependsOn`	`[]string`	No description.
`ForEach`	`ITerraformIterator`	No description.
`Variables`	`*map[string]interface{}`	No description.

`Node`^Required

func Node() Node

Type: github.com/aws/constructs-go/constructs/v10.Node

The tree node.

`CdktfStack`^Required

func CdktfStack() TerraformStack

Type: TerraformStack

`Fqn`^Required

func Fqn() *string

Type: *string

`FriendlyUniqueId`^Required

func FriendlyUniqueId() *string

Type: *string

`Source`^Required

func Source() *string

Type: *string

`Providers`^Optional

func Providers() *[]interface{}

Type: *[]interface{}

`SkipAssetCreationFromLocalModules`^Optional

func SkipAssetCreationFromLocalModules() *bool

Type: *bool

`Version`^Optional

func Version() *string

Type: *string

`DependsOn`^Optional

func DependsOn() *[]*string

Type: *[]*string

`ForEach`^Optional

func ForEach() ITerraformIterator

Type: ITerraformIterator

`Variables`^Optional

func Variables() *map[string]interface{}

Type: *map[string]interface{}

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​scopeRequired

​idRequired

​optionsRequired

​Methods

​ToString

​AddOverride

​pathRequired

​valueRequired

​OverrideLogicalId

​newLogicalIdRequired

​ResetOverrideLogicalId

​ToHclTerraform

​ToMetadata

​ToTerraform

​AddProvider

​providerRequired

​GetString

​outputRequired

​InterpolationForOutput

​moduleOutputRequired

​Get

​outputRequired

​GetBoolean

​outputRequired

​GetList

​outputRequired

​GetNumber

​outputRequired

​Set

​variableRequired

​valueRequired

​Static Functions

​IsConstruct

​xRequired

​IsTerraformElement

​xRequired

​Properties

​NodeRequired

​CdktfStackRequired

​FqnRequired

​FriendlyUniqueIdRequired

​SourceRequired

​ProvidersOptional

​SkipAssetCreationFromLocalModulesOptional

​VersionOptional

​DependsOnOptional

​ForEachOptional

​VariablesOptional

Initializers

`scope`^Required

`id`^Required

`options`^Required

Methods

`ToString`

`AddOverride`

`path`^Required

`value`^Required

`OverrideLogicalId`

`newLogicalId`^Required

`ResetOverrideLogicalId`

`ToHclTerraform`

`ToMetadata`

`ToTerraform`

`AddProvider`

`provider`^Required

`GetString`

`output`^Required

`InterpolationForOutput`

`moduleOutput`^Required

`Get`

`output`^Required

`GetBoolean`

`output`^Required

`GetList`

`output`^Required

`GetNumber`

`output`^Required

`Set`

`variable`^Required

`value`^Required

Static Functions

`IsConstruct`

`x`^Required

`IsTerraformElement`

`x`^Required

Properties

`Node`^Required

`CdktfStack`^Required

`Fqn`^Required

`FriendlyUniqueId`^Required

`Source`^Required

`Providers`^Optional

`SkipAssetCreationFromLocalModules`^Optional

`Version`^Optional

`DependsOn`^Optional

`ForEach`^Optional

`Variables`^Optional