Java: App

CDKTN Core API Reference for App in Java.

Represents a cdktn application.

Initializers

import io.cdktn.cdktn.App;

App.Builder.create()
//  .context(java.util.Map<java.lang.String, java.lang.Object>)
//  .hclOutput(java.lang.Boolean)
//  .outdir(java.lang.String)
//  .skipBackendValidation(java.lang.Boolean)
//  .skipValidation(java.lang.Boolean)
//  .stackTraces(java.lang.Boolean)
    .build();

Name	Type	Description
context	java.util.Map< java.lang.String, java.lang.Object >	Additional context values for the application.
hclOutput	java.lang.Boolean	No description.
outdir	java.lang.String	The directory to output Terraform resources.
skipBackendValidation	java.lang.Boolean	Whether to skip backend validation during synthesis of the app.
skipValidation	java.lang.Boolean	Whether to skip all validations during synthesis of the app.
stackTraces	java.lang.Boolean	No description.

---

context^Optional

• Type: java.util.Map< java.lang.String, java.lang.Object >
• Default: no additional context

Additional context values for the application.

Context set by the CLI or the context key in cdktf.json has precedence.

Context can be read from any construct using node.getContext(key).

---

hclOutput^Optional

• Type: java.lang.Boolean

---

outdir^Optional

• Type: java.lang.String
• Default: CDKTF_OUTDIR if defined, otherwise “cdktf.out”

The directory to output Terraform resources.

If you are using the CDKTN CLI, this value is automatically set from one of the following three sources:

• The -o / --output CLI option
• The CDKTF_OUTDIR environment variable
• The outdir key in cdktf.json

If you are using the CDKTN CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTN library directly (e.g. when writing unit tests).

---

skipBackendValidation^Optional

• Type: java.lang.Boolean
• Default: false

Whether to skip backend validation during synthesis of the app.

---

skipValidation^Optional

• Type: java.lang.Boolean
• Default: false

Whether to skip all validations during synthesis of the app.

---

stackTraces^Optional

• Type: java.lang.Boolean

---

Methods

Name	Description
toString	Returns a string representation of this construct.
with	Applies one or more mixins to this construct.
crossStackReference	Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.
synth	Synthesizes all resources to the output directory.

---

toString

public java.lang.String toString()

Returns a string representation of this construct.

with

public IConstruct with(IMixin... mixins)

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: software.constructs.IMixin…

The mixins to apply.

---

crossStackReference

public java.lang.String crossStackReference(TerraformStack fromStack, TerraformStack toStack, java.lang.String identifier)

Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

fromStack^Required

• Type: TerraformStack

---

toStack^Required

• Type: TerraformStack

---

identifier^Required

• Type: java.lang.String

---

synth

public void synth()

Synthesizes all resources to the output directory.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isApp	No description.
of	No description.

---

isConstruct

import io.cdktn.cdktn.App;

App.isConstruct(java.lang.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.

x^Required

• Type: java.lang.Object

Any object.

---

isApp

import io.cdktn.cdktn.App;

App.isApp(java.lang.Object x)

x^Required

• Type: java.lang.Object

---

of

import io.cdktn.cdktn.App;

App.of(IConstruct construct)

construct^Required

• Type: software.constructs.IConstruct

---

Properties

Name	Type	Description
node	software.constructs.Node	The tree node.
hclOutput	java.lang.Boolean	No description.
manifest	Manifest	No description.
outdir	java.lang.String	The output directory into which resources will be synthesized.
skipBackendValidation	java.lang.Boolean	Whether to skip backend validation during synthesis of the app.
skipValidation	java.lang.Boolean	Whether to skip all validations during synthesis of the app.
targetStackId	java.lang.String	The stack which will be synthesized.

---

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

---

hclOutput^Required

public java.lang.Boolean getHclOutput();

• Type: java.lang.Boolean

---

manifest^Required

public Manifest getManifest();

• Type: Manifest

---

outdir^Required

public java.lang.String getOutdir();

• Type: java.lang.String

The output directory into which resources will be synthesized.

---

skipBackendValidation^Required

public java.lang.Boolean getSkipBackendValidation();

• Type: java.lang.Boolean

Whether to skip backend validation during synthesis of the app.

---

skipValidation^Required

public java.lang.Boolean getSkipValidation();

• Type: java.lang.Boolean

Whether to skip all validations during synthesis of the app.

---

targetStackId^Optional

public java.lang.String getTargetStackId();

• Type: java.lang.String

The stack which will be synthesized.

If not set, all stacks will be synthesized.

---