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
object
Stage
App
Inherited Members
Stage.IsStage(object)
Stage.Of(IConstruct)
Stage.Synth(IStageSynthesisOptions)
Stage.ArtifactId
Stage.AssetOutdir
Stage.Outdir
Stage.PolicyValidationBeta1
Stage.StageName
Stage.Account
Stage.ParentStage
Stage.Region
Namespace: Amazon.CDK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class App : Stage
Syntax (vb)
Public Class App Inherits Stage
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

ExampleMetadata: infused

Examples
using Amazon.CDK;
             using Amazon.CDK.AWS.S3;

             IBucket bucket;


             var app = new App();
             var stack = new Stack(app, "Stack");

             new Table(stack, "Table", new TableProps {
                 PartitionKey = new Attribute {
                     Name = "id",
                     Type = AttributeType.STRING
                 },
                 ImportSource = new ImportSourceSpecification {
                     CompressionType = InputCompressionType.GZIP,
                     InputFormat = InputFormat.Csv(new CsvOptions {
                         Delimiter = ",",
                         HeaderList = new [] { "id", "name" }
                     }),
                     Bucket = bucket,
                     KeyPrefix = "prefix"
                 }
             });

Synopsis

Constructors

App(IAppProps?)

Initializes a CDK application.

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.

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

ExampleMetadata: infused

Methods

IsApp(object)

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

public static bool IsApp(object obj)
Parameters
obj object

The object to evaluate.

Returns

bool

true if obj is an App.

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

ExampleMetadata: infused

Back to top Generated by DocFX