Show / Hide Table of Contents

Class App

A construct which represents an entire CDK app. This construct is normally the root of the construct tree.

Inheritance
System.Object
Construct
Stage
App
Implements
IConstruct
Constructs.IConstruct
IDependable
Inherited Members
Stage.IsStage(Object)
Stage.Of(IConstruct)
Stage.Synth(IStageSynthesisOptions)
Stage.ArtifactId
Stage.AssetOutdir
Stage.Outdir
Stage.StageName
Stage.Account
Stage.ParentStage
Stage.Region
Construct.IsConstruct(Object)
Construct.OnPrepare()
Construct.OnSynthesize(ISynthesisSession)
Construct.OnValidate()
Construct.Prepare()
Construct.Synthesize(ISynthesisSession)
Construct.Validate()
Construct.Node
Namespace: Amazon.CDK
Assembly: Amazon.CDK.dll
Syntax (csharp)
public class App : Stage, IConstruct, IConstruct, IDependable
Syntax (vb)
Public Class App
    Inherits Stage
    Implements IConstruct, IConstruct, IDependable
Remarks

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: https://docs.aws.amazon.com/cdk/latest/guide/apps.html

Synopsis

Constructors

App(IAppProps)

Initializes a CDK application.

App(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

App(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Methods

IsApp(Object)

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

Constructors

App(IAppProps)

Initializes a CDK application.

public App(IAppProps props = null)
Parameters
props IAppProps

initialization properties.

App(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected App(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

App(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected App(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Methods

IsApp(Object)

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

public static bool IsApp(object obj)
Parameters
obj System.Object

The object to evaluate.

Returns

System.Boolean

true if obj is an App.

Implements

IConstruct
Constructs.IConstruct
IDependable
Back to top Generated by DocFX