Package io.github.cdklabs.projen.awscdk

Class CdkConfigOptions.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.CdkConfigOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CdkConfigOptions>

Enclosing interface:

CdkConfigOptions

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

A builder for CdkConfigOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CdkConfigOptions.Builder	app(String app)	Sets the value of CdkConfigOptions.getApp()
CdkConfigOptions	build()	Builds the configured instance.
CdkConfigOptions.Builder	buildCommand(String buildCommand)	Sets the value of CdkConfigCommonOptions.getBuildCommand()
CdkConfigOptions.Builder	cdkout(String cdkout)	Sets the value of CdkConfigCommonOptions.getCdkout()
CdkConfigOptions.Builder	context(Map<String,? extends Object> context)	Sets the value of CdkConfigCommonOptions.getContext()
CdkConfigOptions.Builder	featureFlags(Boolean featureFlags)	Sets the value of CdkConfigCommonOptions.getFeatureFlags()
CdkConfigOptions.Builder	requireApproval(ApprovalLevel requireApproval)	Sets the value of CdkConfigCommonOptions.getRequireApproval()
CdkConfigOptions.Builder	watchExcludes(List<String> watchExcludes)	Sets the value of CdkConfigCommonOptions.getWatchExcludes()
CdkConfigOptions.Builder	watchIncludes(List<String> watchIncludes)	Sets the value of CdkConfigCommonOptions.getWatchIncludes()

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

app

@Stability(Experimental)
public CdkConfigOptions.Builder app(String app)

Sets the value of CdkConfigOptions.getApp()

Parameters:

app - The command line to execute in order to synthesize the CDK application (language specific). This parameter is required.

Returns:

this

buildCommand

@Stability(Experimental)
public CdkConfigOptions.Builder buildCommand(String buildCommand)

Sets the value of CdkConfigCommonOptions.getBuildCommand()

Parameters:

buildCommand - A command to execute before synthesis. This command will be called when running cdk synth or when cdk watch identifies a change in your source code before redeployment.

Returns:

this

cdkout

@Stability(Experimental)
public CdkConfigOptions.Builder cdkout(String cdkout)

Sets the value of CdkConfigCommonOptions.getCdkout()

Parameters:

cdkout - cdk.out directory.

Returns:

this

context

@Stability(Experimental)
public CdkConfigOptions.Builder context(Map<String,? extends Object> context)

Sets the value of CdkConfigCommonOptions.getContext()

Parameters:

context - Additional context to include in cdk.json.

Returns:

this

featureFlags

@Stability(Experimental)
public CdkConfigOptions.Builder featureFlags(Boolean featureFlags)

Sets the value of CdkConfigCommonOptions.getFeatureFlags()

Parameters:

featureFlags - Include all feature flags in cdk.json.

Returns:

this

requireApproval

@Stability(Experimental)
public CdkConfigOptions.Builder requireApproval(ApprovalLevel requireApproval)

Sets the value of CdkConfigCommonOptions.getRequireApproval()

Parameters:

requireApproval - To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them.

Returns:

this

watchExcludes

@Stability(Experimental)
public CdkConfigOptions.Builder watchExcludes(List<String> watchExcludes)

Sets the value of CdkConfigCommonOptions.getWatchExcludes()

Parameters:

watchExcludes - Glob patterns to exclude from cdk watch.

Returns:

this

watchIncludes

@Stability(Experimental)
public CdkConfigOptions.Builder watchIncludes(List<String> watchIncludes)

Sets the value of CdkConfigCommonOptions.getWatchIncludes()

Parameters:

watchIncludes - Glob patterns to include in cdk watch.

Returns:

this

build

@Stability(Experimental)
public CdkConfigOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CdkConfigOptions

Throws:

NullPointerException - if any required attribute was not provided