Package io.github.cdklabs.projen.awscdk

Interface CdkConfigCommonOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsCdkJavaAppOptions, AwsCdkPythonAppOptions, AwsCdkTypeScriptAppOptions, CdkConfigOptions

All Known Implementing Classes:

AwsCdkJavaAppOptions.Jsii$Proxy, AwsCdkPythonAppOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, CdkConfigCommonOptions.Jsii$Proxy, CdkConfigOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.920Z")
@Stability(Experimental)
public interface CdkConfigCommonOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Common options for cdk.json.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CdkConfigCommonOptions.Builder	A builder for CdkConfigCommonOptions
static class	CdkConfigCommonOptions.Jsii$Proxy	An implementation for CdkConfigCommonOptions

Method Summary

Modifier and Type	Method	Description
static CdkConfigCommonOptions.Builder	builder()
default String	getBuildCommand()	(experimental) A command to execute before synthesis.
default String	getCdkout()	(experimental) cdk.out directory.
default Map<String,Object>	getContext()	(experimental) Additional context to include in cdk.json.
default Boolean	getFeatureFlags()	(experimental) Include all feature flags in cdk.json.
default ApprovalLevel	getRequireApproval()	(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 List<String>	getWatchExcludes()	(experimental) Glob patterns to exclude from cdk watch.
default List<String>	getWatchIncludes()	(experimental) Glob patterns to include in cdk watch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBuildCommand

@Stability(Experimental)
@Nullable
default String getBuildCommand()

(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

getCdkout

@Stability(Experimental)
@Nullable
default String getCdkout()

(experimental) cdk.out directory.

Default: "cdk.out"

getContext

@Stability(Experimental)
@Nullable
default Map<String,Object> getContext()

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

Default: - no additional context

getFeatureFlags

@Stability(Experimental)
@Nullable
default Boolean getFeatureFlags()

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

Default: true

getRequireApproval

@Stability(Experimental)
@Nullable
default ApprovalLevel getRequireApproval()

(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

getWatchExcludes

@Stability(Experimental)
@Nullable
default List<String> getWatchExcludes()

(experimental) Glob patterns to exclude from cdk watch.

Default: []

getWatchIncludes

@Stability(Experimental)
@Nullable
default List<String> getWatchIncludes()

(experimental) Glob patterns to include in cdk watch.

Default: []

builder

@Stability(Experimental)
static CdkConfigCommonOptions.Builder builder()

Returns:

a CdkConfigCommonOptions.Builder of CdkConfigCommonOptions