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.

Represents a cdktn application.

​
Initializers 

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

cdktn.NewApp(config AppConfig) App
NameTypeDescription
configAppConfigconfiguration.

​
configOptional

configuration.

​
Methods

NameDescription
ToStringReturns a string representation of this construct.
CrossStackReferenceCreates a reference from one stack to another, invoked on prepareStack since it creates extra resources.
SynthSynthesizes all resources to the output directory.

​
ToString 

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

​
CrossStackReference 

func CrossStackReference(fromStack TerraformStack, toStack TerraformStack, identifier *string) *string
Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

​
fromStackRequired

​
toStackRequired

​
identifierRequired

  • Type: *string

​
Synth 

func Synth()
Synthesizes all resources to the output directory.

​
Static Functions

NameDescription
IsConstructChecks if x is a construct.
IsAppNo description.
OfNo description.

​
IsConstruct 

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

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

​
IsApp 

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

cdktn.App_IsApp(x interface{}) *bool

​
xRequired

  • Type: interface{}

​
Of 

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

cdktn.App_Of(construct IConstruct) App

​
constructRequired

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

​
Properties

NameTypeDescription
Nodegithub.com/aws/constructs-go/constructs/v10.NodeThe tree node.
HclOutput*boolNo description.
ManifestManifestNo description.
Outdir*stringThe output directory into which resources will be synthesized.
SkipBackendValidation*boolWhether to skip backend validation during synthesis of the app.
SkipValidation*boolWhether to skip all validations during synthesis of the app.
TargetStackId*stringThe stack which will be synthesized.

​
NodeRequired 

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

​
HclOutputRequired 

func HclOutput() *bool
  • Type: *bool

​
ManifestRequired 

func Manifest() Manifest

​
OutdirRequired 

func Outdir() *string
  • Type: *string
The output directory into which resources will be synthesized.

​
SkipBackendValidationRequired 

func SkipBackendValidation() *bool
  • Type: *bool
Whether to skip backend validation during synthesis of the app.

​
SkipValidationRequired 

func SkipValidation() *bool
  • Type: *bool
Whether to skip all validations during synthesis of the app.

​
TargetStackIdOptional 

func TargetStackId() *string
  • Type: *string
The stack which will be synthesized. If not set, all stacks will be synthesized.