Go: TerraformStack - CDK Terrain (CDKTN)

Initializers

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

cdktn.NewTerraformStack(scope Construct, id *string) TerraformStack

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

`scope`^Required

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

`id`^Required

Type: *string

Methods

Name	Description
`ToString`	Returns a string representation of this construct.
`With`	Applies one or more mixins to this construct.
`AddDependency`	No description.
`AddOverride`	No description.
`AllProviders`	No description.
`DependsOn`	No description.
`EnsureBackendExists`	No description.
`GetLogicalId`	No description.
`HasResourceMove`	No description.
`PrepareStack`	No description.
`RegisterIncomingCrossStackReference`	No description.
`RegisterOutgoingCrossStackReference`	No description.
`RunAllValidations`	Run all validations on the stack.
`ToHclTerraform`	No description.
`ToTerraform`	No description.

`ToString`

func ToString() *string

Returns a string representation of this construct.

`With`

func With(mixins ...IMixin) IConstruct

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: …github.com/aws/constructs-go/constructs/v10.IMixin

The mixins to apply.

`AddDependency`

func AddDependency(dependency TerraformStack)

`dependency`^Required

Type: TerraformStack

`AddOverride`

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

`path`^Required

Type: *string

`value`^Required

Type: interface{}

`AllProviders`

func AllProviders() *[]TerraformProvider

`DependsOn`

func DependsOn(stack TerraformStack) *bool

`stack`^Required

Type: TerraformStack

`EnsureBackendExists`

func EnsureBackendExists() TerraformBackend

`GetLogicalId`

func GetLogicalId(tfElement interface{}) *string

`tfElement`^Required

Type: interface{}

`HasResourceMove`

func HasResourceMove() *bool

`PrepareStack`

func PrepareStack()

`RegisterIncomingCrossStackReference`

func RegisterIncomingCrossStackReference(fromStack TerraformStack) TerraformRemoteState

`fromStack`^Required

Type: TerraformStack

`RegisterOutgoingCrossStackReference`

func RegisterOutgoingCrossStackReference(identifier *string) TerraformOutput

`identifier`^Required

Type: *string

`RunAllValidations`

func RunAllValidations()

Run all validations on the stack.

`ToHclTerraform`

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

`ToTerraform`

func ToTerraform() interface{}

Static Functions

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

`IsConstruct`

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

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

`IsStack`

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

cdktn.TerraformStack_IsStack(x interface{}) *bool

`x`^Required

Type: interface{}

`Of`

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

cdktn.TerraformStack_Of(construct IConstruct) TerraformStack

`construct`^Required

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

Properties

Name	Type	Description
`Node`	`github.com/aws/constructs-go/constructs/v10.Node`	The tree node.
`Dependencies`	`*[]TerraformStack`	No description.
`MoveTargets`	`TerraformResourceTargets`	No description.
`Synthesizer`	`IStackSynthesizer`	No description.

`Node`^Required

func Node() Node

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

The tree node.

`Dependencies`^Required

func Dependencies() *[]TerraformStack

Type: *[]TerraformStack

`MoveTargets`^Required

func MoveTargets() TerraformResourceTargets

Type: TerraformResourceTargets

`Synthesizer`^Required

func Synthesizer() IStackSynthesizer

Type: IStackSynthesizer

​Initializers

​scopeRequired

​idRequired

​Methods

​ToString

​With

​mixinsRequired

​AddDependency

​dependencyRequired

​AddOverride

​pathRequired

​valueRequired

​AllProviders

​DependsOn

​stackRequired

​EnsureBackendExists

​GetLogicalId

​tfElementRequired

​HasResourceMove

​PrepareStack

​RegisterIncomingCrossStackReference

​fromStackRequired

​RegisterOutgoingCrossStackReference

​identifierRequired

​RunAllValidations

​ToHclTerraform

​ToTerraform

​Static Functions

​IsConstruct

​xRequired

​IsStack

​xRequired

​Of

​constructRequired

​Properties

​NodeRequired

​DependenciesRequired

​MoveTargetsRequired

​SynthesizerRequired

Initializers

`scope`^Required

`id`^Required

Methods

`ToString`

`With`

`mixins`^Required

`AddDependency`

`dependency`^Required

`AddOverride`

`path`^Required

`value`^Required

`AllProviders`

`DependsOn`

`stack`^Required

`EnsureBackendExists`

`GetLogicalId`

`tfElement`^Required

`HasResourceMove`

`PrepareStack`

`RegisterIncomingCrossStackReference`

`fromStack`^Required

`RegisterOutgoingCrossStackReference`

`identifier`^Required

`RunAllValidations`

`ToHclTerraform`

`ToTerraform`

Static Functions

`IsConstruct`

`x`^Required

`IsStack`

`x`^Required

`Of`

`construct`^Required

Properties

`Node`^Required

`Dependencies`^Required

`MoveTargets`^Required

`Synthesizer`^Required