Package software.aws.awsprototypingsdk.pdknag

Class PDKNagAppProps.Builder

java.lang.Object

software.aws.awsprototypingsdk.pdknag.PDKNagAppProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PDKNagAppProps>

Enclosing interface:

PDKNagAppProps

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

A builder for PDKNagAppProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PDKNagAppProps.Builder	analyticsReporting(Boolean analyticsReporting)	Sets the value of AppProps.getAnalyticsReporting()
PDKNagAppProps.Builder	autoSynth(Boolean autoSynth)	Sets the value of AppProps.getAutoSynth()
PDKNagAppProps	build()	Builds the configured instance.
PDKNagAppProps.Builder	context(Map<String,? extends Object> context)	Sets the value of AppProps.getContext()
PDKNagAppProps.Builder	failOnError(Boolean failOnError)	Sets the value of PDKNagAppProps.getFailOnError()
PDKNagAppProps.Builder	failOnWarning(Boolean failOnWarning)	Sets the value of PDKNagAppProps.getFailOnWarning()
PDKNagAppProps.Builder	nagPacks(List<? extends io.github.cdklabs.cdknag.NagPack> nagPacks)	Sets the value of PDKNagAppProps.getNagPacks()
PDKNagAppProps.Builder	outdir(String outdir)	Sets the value of AppProps.getOutdir()
PDKNagAppProps.Builder	postCliContext(Map<String,? extends Object> postCliContext)	Sets the value of AppProps.getPostCliContext()
PDKNagAppProps.Builder	stackTraces(Boolean stackTraces)	Sets the value of AppProps.getStackTraces()
PDKNagAppProps.Builder	treeMetadata(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

failOnError

@Stability(Stable)
public PDKNagAppProps.Builder failOnError(Boolean failOnError)

Sets the value of PDKNagAppProps.getFailOnError()

Parameters:

failOnError - Determines whether any errors encountered should trigger a test failure.

Returns:

this

failOnWarning

@Stability(Stable)
public PDKNagAppProps.Builder failOnWarning(Boolean failOnWarning)

Sets the value of PDKNagAppProps.getFailOnWarning()

Parameters:

failOnWarning - Determines whether any warnings encountered should trigger a test failure.

Returns:

this

nagPacks

@Stability(Stable)
public PDKNagAppProps.Builder nagPacks(List<? extends io.github.cdklabs.cdknag.NagPack> nagPacks)

Sets the value of PDKNagAppProps.getNagPacks()

Parameters:

nagPacks - Custom nag packs to execute.

Returns:

this

analyticsReporting

@Stability(Stable)
public PDKNagAppProps.Builder analyticsReporting(Boolean analyticsReporting)

Sets the value of AppProps.getAnalyticsReporting()

Parameters:

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

Returns:

this

autoSynth

@Stability(Stable)
public PDKNagAppProps.Builder autoSynth(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

@Stability(Stable)
public PDKNagAppProps.Builder context(Map<String,? extends 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

@Stability(Stable)
public PDKNagAppProps.Builder outdir(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

postCliContext

@Stability(Stable)
public PDKNagAppProps.Builder postCliContext(Map<String,? extends Object> postCliContext)

Sets the value of AppProps.getPostCliContext()

Parameters:

postCliContext - Additional context values for the application. Context provided here has precedence over context set by:

• The CLI via --context
• The context key in cdk.json
• The {@link AppProps.context} property

This property is recommended over the {@link AppProps.context} property since you can make final decision over which context value to take in your app.

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

Returns:

this

stackTraces

@Stability(Stable)
public PDKNagAppProps.Builder stackTraces(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

@Stability(Stable)
public PDKNagAppProps.Builder treeMetadata(Boolean treeMetadata)

Sets the value of AppProps.getTreeMetadata()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public PDKNagAppProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of PDKNagAppProps

Throws:

NullPointerException - if any required attribute was not provided