A construct which represents an entire CDK app. This construct is normally the root of the construct tree.
You would normally define an
App instance in your program's entrypoint,
then define constructs where the app is used as the parent scope.
After all the child constructs are defined within the app, you should call
app.synth() which will emit a "cloud assembly" from this app into the
directory specified by
outdir. Cloud assemblies includes artifacts such as
CloudFormation templates and assets that are needed to deploy this app into
the AWS cloud.
new App(props?: AppProps)
App— initialization properties.
Initializes a CDK application.
|artifact||Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.|
|node||The construct tree node associated with this construct.|
|outdir||The cloud assembly output directory.|
|stage||The name of the stage.|
|account?||The default account for all resources defined within this stage.|
|parent||The parent stage or |
|region?||The default region for all resources defined within this stage.|
Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string.
Derived from the construct path.
The construct tree node associated with this construct.
The cloud assembly output directory.
The name of the stage.
Based on names of the parent stages separated by hypens.
The default account for all resources defined within this stage.
The parent stage or
undefined if this is the app.
The default region for all resources defined within this stage.
|synth(options?)||Synthesize this stage into a cloud assembly.|
|to||Returns a string representation of this construct.|
|static is||Checks if an object is an instance of the |
public synth(options?: StageSynthesisOptions): CloudAssembly
Synthesize this stage into a cloud assembly.
Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly.
public toString(): string
Returns a string representation of this construct.
public static isApp(obj: any): boolean
any— The object to evaluate.
Checks if an object is an instance of the