software.amazon.awscdk.core

Class App

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.App

All Implemented Interfaces:

IDependable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.4.1 (build 0b09d7b)",
           date="2020-04-28T11:03:57.220Z")
 @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.html

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	App.Builder A fluent builder for App.

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 initializationMode)
protected	App(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static Boolean	isApp(Object obj) Checks if an object is an instance of the `App` class.
protected void	prepare() Perform final modifications before synthesis.
CloudAssembly	synth() Synthesizes a cloud assembly for this app.

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

getNode, isConstruct, onPrepare, onSynthesize, onValidate, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, 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.JsiiObjectRef objRef)

App

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

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)
 @NotNull
public static Boolean isApp(@NotNull
                                                               Object obj)

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

Parameters:

obj - The object to evaluate. This parameter is required.

Returns:

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

prepare

@Stability(value=Stable)
protected void prepare()

Perform final modifications before synthesis.

This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.

This is an advanced framework feature. Only use this if you understand the implications.

Overrides:

prepare in class Construct

synth

@Stability(value=Stable)
 @NotNull
public 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.