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 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();
NameTypeDescription
contextjava.util.Map< java.lang.String, java.lang.Object >Additional context values for the application.
hclOutputjava.lang.BooleanNo description.
outdirjava.lang.StringThe directory to output Terraform resources.
skipBackendValidationjava.lang.BooleanWhether to skip backend validation during synthesis of the app.
skipValidationjava.lang.BooleanWhether to skip all validations during synthesis of the app.
stackTracesjava.lang.BooleanNo description.

​
contextOptional

  • 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).

​
hclOutputOptional

  • Type: java.lang.Boolean

​
outdirOptional

  • 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).

​
skipBackendValidationOptional

  • Type: java.lang.Boolean
  • Default: false
Whether to skip backend validation during synthesis of the app.

​
skipValidationOptional

  • Type: java.lang.Boolean
  • Default: false
Whether to skip all validations during synthesis of the app.

​
stackTracesOptional

  • Type: java.lang.Boolean

​
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 

public java.lang.String toString()
Returns a string representation of this construct.

​
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.

​
fromStackRequired

​
toStackRequired

​
identifierRequired

  • Type: java.lang.String

​
synth 

public void synth()
Synthesizes all resources to the output directory.

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isAppNo description.
ofNo 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.

​
xRequired

  • Type: java.lang.Object
Any object.

​
isApp 

import io.cdktn.cdktn.App;

App.isApp(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
of 

import io.cdktn.cdktn.App;

App.of(IConstruct construct)

​
constructRequired

  • Type: software.constructs.IConstruct

​
Properties

NameTypeDescription
nodesoftware.constructs.NodeThe tree node.
hclOutputjava.lang.BooleanNo description.
manifestManifestNo description.
outdirjava.lang.StringThe output directory into which resources will be synthesized.
skipBackendValidationjava.lang.BooleanWhether to skip backend validation during synthesis of the app.
skipValidationjava.lang.BooleanWhether to skip all validations during synthesis of the app.
targetStackIdjava.lang.StringThe stack which will be synthesized.

​
nodeRequired 

public Node getNode();
  • Type: software.constructs.Node
The tree node.

​
hclOutputRequired 

public java.lang.Boolean getHclOutput();
  • Type: java.lang.Boolean

​
manifestRequired 

public Manifest getManifest();

​
outdirRequired 

public java.lang.String getOutdir();
  • Type: java.lang.String
The output directory into which resources will be synthesized.

​
skipBackendValidationRequired 

public java.lang.Boolean getSkipBackendValidation();
  • Type: java.lang.Boolean
Whether to skip backend validation during synthesis of the app.

​
skipValidationRequired 

public java.lang.Boolean getSkipValidation();
  • Type: java.lang.Boolean
Whether to skip all validations during synthesis of the app.

​
targetStackIdOptional 

public java.lang.String getTargetStackId();
  • Type: java.lang.String
The stack which will be synthesized. If not set, all stacks will be synthesized.