io.github.cdklabs.projen.awscdk

Class CdkConfig.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.CdkConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CdkConfig>

Enclosing class:

CdkConfig

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

(experimental) A fluent builder for CdkConfig.

Method Summary

Modifier and Type	Method and Description
CdkConfig.Builder	app(String app) (experimental) The command line to execute in order to synthesize the CDK application (language specific).
CdkConfig	build()
CdkConfig.Builder	buildCommand(String buildCommand) (experimental) A command to execute before synthesis.
CdkConfig.Builder	cdkout(String cdkout) (experimental) cdk.out directory.
CdkConfig.Builder	context(Map<String,String> context) (experimental) Additional context to include in `cdk.json`.
static CdkConfig.Builder	create(Project project)
CdkConfig.Builder	featureFlags(Boolean featureFlags) (experimental) Include all feature flags in cdk.json.
CdkConfig.Builder	requireApproval(ApprovalLevel requireApproval) (experimental) 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.
CdkConfig.Builder	watchExcludes(List<String> watchExcludes) (experimental) Glob patterns to exclude from `cdk watch`.
CdkConfig.Builder	watchIncludes(List<String> watchIncludes) (experimental) Glob patterns to include in `cdk watch`.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static CdkConfig.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of CdkConfig.Builder.

buildCommand

@Stability(value=Experimental)
public CdkConfig.Builder buildCommand(String buildCommand)

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

Default: - no build command

Parameters:

buildCommand - A command to execute before synthesis. This parameter is required.

Returns:

this

cdkout

@Stability(value=Experimental)
public CdkConfig.Builder cdkout(String cdkout)

(experimental) cdk.out directory.

Default: "cdk.out"

Parameters:

cdkout - cdk.out directory. This parameter is required.

Returns:

this

context

@Stability(value=Experimental)
public CdkConfig.Builder context(Map<String,String> context)

(experimental) Additional context to include in `cdk.json`.

Default: - no additional context

Parameters:

context - Additional context to include in `cdk.json`. This parameter is required.

Returns:

this

featureFlags

@Stability(value=Experimental)
public CdkConfig.Builder featureFlags(Boolean featureFlags)

(experimental) Include all feature flags in cdk.json.

Default: true

Parameters:

featureFlags - Include all feature flags in cdk.json. This parameter is required.

Returns:

this

requireApproval

@Stability(value=Experimental)
public CdkConfig.Builder requireApproval(ApprovalLevel requireApproval)

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

Default: ApprovalLevel.BROADENING

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. This parameter is required.

Returns:

this

watchExcludes

@Stability(value=Experimental)
public CdkConfig.Builder watchExcludes(List<String> watchExcludes)

(experimental) Glob patterns to exclude from `cdk watch`.

Default: []

Parameters:

watchExcludes - Glob patterns to exclude from `cdk watch`. This parameter is required.

Returns:

this

watchIncludes

@Stability(value=Experimental)
public CdkConfig.Builder watchIncludes(List<String> watchIncludes)

(experimental) Glob patterns to include in `cdk watch`.

Default: []

Parameters:

watchIncludes - Glob patterns to include in `cdk watch`. This parameter is required.

Returns:

this

app

@Stability(value=Experimental)
public CdkConfig.Builder app(String app)

(experimental) The command line to execute in order to synthesize the CDK application (language specific).

Parameters:

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

Returns:

this

build

@Stability(value=Experimental)
public CdkConfig build()

Specified by:

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