Package io.github.cdklabs.projen.awscdk

Class CdkConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.awscdk.CdkConfig

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.919Z")
@Stability(Experimental)
public class CdkConfig
extends Component

(experimental) Represents cdk.json file.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CdkConfig.Builder	(experimental) A fluent builder for CdkConfig.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	CdkConfig(Project project, CdkConfigOptions options)
protected	CdkConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CdkConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addExcludes(@NotNull String... patterns)	(experimental) Add excludes to cdk.json.
void	addIncludes(@NotNull String... patterns)	(experimental) Add includes to cdk.json.
String	getCdkout()	(experimental) Name of the cdk.out directory.
List<String>	getExclude()	(experimental) List of glob patterns to be excluded by CDK.
List<String>	getInclude()	(experimental) List of glob patterns to be included by CDK.
JsonFile	getJson()	(experimental) Represents the JSON file.

Methods inherited from class io.github.cdklabs.projen.Component

getProject, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

CdkConfig

protected CdkConfig(software.amazon.jsii.JsiiObjectRef objRef)

CdkConfig

protected CdkConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CdkConfig

@Stability(Experimental)
public CdkConfig(@NotNull
                 Project project,
                 @NotNull
                 CdkConfigOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

addExcludes

@Stability(Experimental)
public void addExcludes(@NotNull
                        @NotNull String... patterns)

(experimental) Add excludes to cdk.json.

Parameters:

patterns - The excludes to add. This parameter is required.

addIncludes

@Stability(Experimental)
public void addIncludes(@NotNull
                        @NotNull String... patterns)

(experimental) Add includes to cdk.json.

Parameters:

patterns - The includes to add. This parameter is required.

getCdkout

@Stability(Experimental)
@NotNull
public String getCdkout()

(experimental) Name of the cdk.out directory.

getExclude

@Stability(Experimental)
@NotNull
public List<String> getExclude()

(experimental) List of glob patterns to be excluded by CDK.

getInclude

@Stability(Experimental)
@NotNull
public List<String> getInclude()

(experimental) List of glob patterns to be included by CDK.

getJson

@Stability(Experimental)
@NotNull
public JsonFile getJson()

(experimental) Represents the JSON file.