software.amazon.awscdk.core

Class App.Builder

java.lang.Object

software.amazon.awscdk.core.App.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<App>

Enclosing class:

App

@Stability(value=Stable)
public static final class App.Builder
extends Object
implements software.amazon.jsii.Builder<App>

A fluent builder for App.

Method Summary

Modifier and Type	Method and Description
App.Builder	analyticsReporting(Boolean analyticsReporting) Include runtime versioning information in the Stacks of this app.
App.Builder	autoSynth(Boolean autoSynth) Automatically call `synth()` before the program exits.
App	build()
App.Builder	context(Map<String,? extends Object> context) Additional context values for the application.
static App.Builder	create()
App.Builder	outdir(String outdir) The output directory into which to emit synthesized artifacts.
App.Builder	runtimeInfo(Boolean runtimeInfo) Deprecated. use `versionReporting` instead
App.Builder	stackTraces(Boolean stackTraces) Include construct creation stack trace in the `aws:cdk:trace` metadata key of all constructs.
App.Builder	treeMetadata(Boolean treeMetadata) Include construct tree metadata as part of the Cloud Assembly.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static App.Builder create()

Returns:

a new instance of App.Builder.

analyticsReporting

@Stability(value=Stable)
public App.Builder analyticsReporting(Boolean analyticsReporting)

Include runtime versioning information in the Stacks of this app.

Default: Value of 'aws:cdk:version-reporting' context key

Parameters:

analyticsReporting - Include runtime versioning information in the Stacks of this app. This parameter is required.

Returns:

this

autoSynth

@Stability(value=Stable)
public App.Builder autoSynth(Boolean autoSynth)

Automatically call `synth()` before the program exits.

If you set this, you don't have to call synth() explicitly. Note that this feature is only available for certain programming languages, and calling synth() is still recommended.

Default: true if running via CDK CLI (`CDK_OUTDIR` is set), `false` otherwise

Parameters:

autoSynth - Automatically call `synth()` before the program exits. This parameter is required.

Returns:

this

context

@Stability(value=Stable)
public App.Builder context(Map<String,? extends Object> context)

Additional context values for the application.

Context set by the CLI or the context key in cdk.json has precedence.

Context can be read from any construct using node.getContext(key).

Default: - no additional context

Parameters:

context - Additional context values for the application. This parameter is required.

Returns:

this

outdir

@Stability(value=Stable)
public App.Builder outdir(String outdir)

The output directory into which to emit synthesized artifacts.

You should never need to set this value. By default, the value you pass to the CLI's --output flag will be used, and if you change it to a different directory the CLI will fail to pick up the generated Cloud Assembly.

This property is intended for internal and testing use.

Default: - If this value is _not_ set, considers the environment variable `CDK_OUTDIR`. If `CDK_OUTDIR` is not defined, uses a temp directory.

Parameters:

outdir - The output directory into which to emit synthesized artifacts. This parameter is required.

Returns:

this

runtimeInfo

@Stability(value=Deprecated)
 @Deprecated
public App.Builder runtimeInfo(Boolean runtimeInfo)

Deprecated. use `versionReporting` instead

(deprecated) Include runtime versioning information in the Stacks of this app.

Default: Value of 'aws:cdk:version-reporting' context key

Parameters:

runtimeInfo - Include runtime versioning information in the Stacks of this app. This parameter is required.

Returns:

this

stackTraces

@Stability(value=Stable)
public App.Builder stackTraces(Boolean stackTraces)

Include construct creation stack trace in the `aws:cdk:trace` metadata key of all constructs.

Default: true stack traces are included unless `aws:cdk:disable-stack-trace` is set in the context.

Parameters:

stackTraces - Include construct creation stack trace in the `aws:cdk:trace` metadata key of all constructs. This parameter is required.

Returns:

this

treeMetadata

@Stability(value=Stable)
public App.Builder treeMetadata(Boolean treeMetadata)

Include construct tree metadata as part of the Cloud Assembly.

Default: true

Parameters:

treeMetadata - Include construct tree metadata as part of the Cloud Assembly. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public App build()

Specified by:

build in interface software.amazon.jsii.Builder<App>