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.
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. |
scopeRequired
- Type: github.com/aws/constructs-go/constructs/v10.Construct
idRequired
Methods
| Name | Description |
|---|
ToString | Returns a string representation of 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
Returns a string representation of this construct.
AddDependency
func AddDependency(dependency TerraformStack)
dependencyRequired
AddOverride
func AddOverride(path *string, value interface{})
pathRequired
valueRequired
AllProviders
func AllProviders() *[]TerraformProvider
DependsOn
func DependsOn(stack TerraformStack) *bool
stackRequired
EnsureBackendExists
func EnsureBackendExists() TerraformBackend
GetLogicalId
func GetLogicalId(tfElement interface{}) *string
tfElementRequired
HasResourceMove
func HasResourceMove() *bool
PrepareStack
RegisterIncomingCrossStackReference
func RegisterIncomingCrossStackReference(fromStack TerraformStack) TerraformRemoteState
fromStackRequired
RegisterOutgoingCrossStackReference
func RegisterOutgoingCrossStackReference(identifier *string) TerraformOutput
identifierRequired
RunAllValidations
Run all validations on the stack.
func ToHclTerraform() *map[string]interface{}
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
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.
IsStack
import "github.com/open-constructs/cdk-terrain-go/cdktn"
cdktn.TerraformStack_IsStack(x interface{}) *bool
xRequired
import "github.com/open-constructs/cdk-terrain-go/cdktn"
cdktn.TerraformStack_Of(construct IConstruct) TerraformStack
constructRequired
- 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. |
NodeRequired
- Type: github.com/aws/constructs-go/constructs/v10.Node
The tree node.
DependenciesRequired
func Dependencies() *[]TerraformStack
MoveTargetsRequired
func MoveTargets() TerraformResourceTargets
SynthesizerRequired
func Synthesizer() IStackSynthesizer
