software.amazon.awscdk.core

Class App

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.App

All Implemented Interfaces:

IConstruct, IDependable, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/0.14.3 (build 1b1062d)",
           date="2019-08-14T08:10:20.256Z")
 @Stability(value=Stable)
public class App
extends Construct

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.

See Also:

https://docs.aws.amazon.com/cdk/latest/guide/apps_and_stacks.html

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
	App() Initializes a CDK application.
	App(AppProps props) Initializes a CDK application.
protected	App(software.amazon.jsii.JsiiObject.InitializationMode mode)

Method Summary

Modifier and Type	Method and Description
static Boolean	isApp(Object obj) Checks if an object is an instance of the `App` class.
software.amazon.awscdk.cxapi.CloudAssembly	synth() Synthesizes a cloud assembly for this app.

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, prepare, synthesize, toString, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiCall, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticGet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

App

protected App(software.amazon.jsii.JsiiObject.InitializationMode mode)

App

@Stability(value=Stable)
public App(@Nullable
                                    AppProps props)

Initializes a CDK application.

Parameters:

props - initialization properties.

App

@Stability(value=Stable)
public App()

Initializes a CDK application.

Method Detail

isApp

@Stability(value=Stable)
public static Boolean isApp(@Nullable
                                                     Object obj)

Checks if an object is an instance of the `App` class.

Parameters:

obj - The object to evaluate.

Returns:

`true` if `obj` is an `App`.

synth

@Stability(value=Stable)
public software.amazon.awscdk.cxapi.CloudAssembly synth()

Synthesizes a cloud assembly for this app. Emits it to the directory specified by `outdir`.

Returns:

a `CloudAssembly` which can be used to inspect synthesized artifacts such as CloudFormation templates and assets.