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 

using Io.Cdktn;

new App(AppConfig Config = null);
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 

private string ToString()
Returns a string representation of this construct.

​
CrossStackReference 

private string CrossStackReference(TerraformStack FromStack, TerraformStack ToStack, string Identifier)
Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

​
FromStackRequired

​
ToStackRequired

​
IdentifierRequired

  • Type: string

​
Synth 

private void Synth()
Synthesizes all resources to the output directory.

​
Static Functions

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

​
IsConstruct 

using Io.Cdktn;

App.IsConstruct(object X);
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: object
Any object.

​
IsApp 

using Io.Cdktn;

App.IsApp(object X);

​
XRequired

  • Type: object

​
Of 

using Io.Cdktn;

App.Of(IConstruct Construct);

​
ConstructRequired

  • Type: Constructs.IConstruct

​
Properties

NameTypeDescription
NodeConstructs.NodeThe tree node.
HclOutputboolNo description.
ManifestManifestNo description.
OutdirstringThe output directory into which resources will be synthesized.
SkipBackendValidationboolWhether to skip backend validation during synthesis of the app.
SkipValidationboolWhether to skip all validations during synthesis of the app.
TargetStackIdstringThe stack which will be synthesized.

​
NodeRequired 

public Node Node { get; }
  • Type: Constructs.Node
The tree node.

​
HclOutputRequired 

public bool HclOutput { get; }
  • Type: bool

​
ManifestRequired 

public Manifest Manifest { get; }

​
OutdirRequired 

public string Outdir { get; }
  • Type: string
The output directory into which resources will be synthesized.

​
SkipBackendValidationRequired 

public bool SkipBackendValidation { get; }
  • Type: bool
Whether to skip backend validation during synthesis of the app.

​
SkipValidationRequired 

public bool SkipValidation { get; }
  • Type: bool
Whether to skip all validations during synthesis of the app.

​
TargetStackIdOptional 

public string TargetStackId { get; }
  • Type: string
The stack which will be synthesized. If not set, all stacks will be synthesized.