software.amazon.awscdk.core

Class AppProps.Builder

java.lang.Object

software.amazon.awscdk.core.AppProps.Builder

Enclosing interface:

AppProps

public static final class AppProps.Builder
extends java.lang.Object

A builder for AppProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AppProps.Builder	analyticsReporting(java.lang.Boolean analyticsReporting) Sets the value of AppProps.getAnalyticsReporting()
AppProps.Builder	autoSynth(java.lang.Boolean autoSynth) Sets the value of AppProps.getAutoSynth()
AppProps	build() Builds the configured instance.
AppProps.Builder	context(java.util.Map<java.lang.String,? extends java.lang.Object> context) Sets the value of AppProps.getContext()
AppProps.Builder	outdir(java.lang.String outdir) Sets the value of AppProps.getOutdir()
AppProps.Builder	runtimeInfo(java.lang.Boolean runtimeInfo) Deprecated. use `versionReporting` instead
AppProps.Builder	stackTraces(java.lang.Boolean stackTraces) Sets the value of AppProps.getStackTraces()
AppProps.Builder	treeMetadata(java.lang.Boolean treeMetadata) Sets the value of AppProps.getTreeMetadata()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

analyticsReporting

public AppProps.Builder analyticsReporting(java.lang.Boolean analyticsReporting)

Sets the value of AppProps.getAnalyticsReporting()

Parameters:

analyticsReporting - Include runtime versioning information in the Stacks of this app.

Returns:

this

autoSynth

public AppProps.Builder autoSynth(java.lang.Boolean autoSynth)

Sets the value of AppProps.getAutoSynth()

Parameters:

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.

Returns:

this

context

public AppProps.Builder context(java.util.Map<java.lang.String,? extends java.lang.Object> context)

Sets the value of AppProps.getContext()

Parameters:

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).

Returns:

this

outdir

public AppProps.Builder outdir(java.lang.String outdir)

Sets the value of AppProps.getOutdir()

Parameters:

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.

Returns:

this

runtimeInfo

@Deprecated
public AppProps.Builder runtimeInfo(java.lang.Boolean runtimeInfo)

Deprecated. use `versionReporting` instead

Sets the value of AppProps.getRuntimeInfo()

Parameters:

runtimeInfo - Include runtime versioning information in the Stacks of this app.

Returns:

this

stackTraces

public AppProps.Builder stackTraces(java.lang.Boolean stackTraces)

Sets the value of AppProps.getStackTraces()

Parameters:

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

Returns:

this

treeMetadata

public AppProps.Builder treeMetadata(java.lang.Boolean treeMetadata)

Sets the value of AppProps.getTreeMetadata()

Parameters:

treeMetadata - Include construct tree metadata as part of the Cloud Assembly.

Returns:

this

build

public AppProps build()

Builds the configured instance.

Returns:

a new instance of AppProps

Throws:

java.lang.NullPointerException - if any required attribute was not provided