io.github.cdklabs.projen.awscdk

Class AwsCdkDeps.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.AwsCdkDeps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsCdkDeps>

Enclosing class:

AwsCdkDeps

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

(experimental) A fluent builder for AwsCdkDeps.

Method Summary

Modifier and Type	Method and Description
AwsCdkDeps	build()
AwsCdkDeps.Builder	cdkAssert(Boolean cdkAssert) Deprecated. The
AwsCdkDeps.Builder	cdkAssertions(Boolean cdkAssertions) (experimental) Install the @aws-cdk/assertions library?
AwsCdkDeps.Builder	cdkDependencies(List<String> cdkDependencies) Deprecated. For CDK 2.x use 'peerDeps' instead
AwsCdkDeps.Builder	cdkDependenciesAsDeps(Boolean cdkDependenciesAsDeps) Deprecated. Not supported in CDK v2.
AwsCdkDeps.Builder	cdkTestDependencies(List<String> cdkTestDependencies) Deprecated. For CDK 2.x use 'devDeps' instead
AwsCdkDeps.Builder	cdkVersion(String cdkVersion) (experimental) Minimum version of the AWS CDK to depend on.
AwsCdkDeps.Builder	cdkVersionPinning(Boolean cdkVersionPinning) (experimental) Use pinned version instead of caret version for CDK.
AwsCdkDeps.Builder	constructsVersion(String constructsVersion) (experimental) Minimum version of the `constructs` library to depend on.
static AwsCdkDeps.Builder	create(Project project)
AwsCdkDeps.Builder	dependencyType(DependencyType dependencyType) (experimental) The type of dependency to use for runtime AWS CDK and `constructs` modules.

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 AwsCdkDeps.Builder create(Project project)

Parameters:

project - This parameter is required.

Returns:

a new instance of AwsCdkDeps.Builder.

cdkVersion

@Stability(value=Experimental)
public AwsCdkDeps.Builder cdkVersion(String cdkVersion)

(experimental) Minimum version of the AWS CDK to depend on.

Default: "2.1.0"

Parameters:

cdkVersion - Minimum version of the AWS CDK to depend on. This parameter is required.

Returns:

this

cdkAssert

@Stability(value=Deprecated)
 @Deprecated
public AwsCdkDeps.Builder cdkAssert(Boolean cdkAssert)

Deprecated. The

(deprecated) Install the @aws-cdk/assert library?

Default: - will be included by default for AWS CDK >= 1.0.0 < 2.0.0

Parameters:

cdkAssert - Install the @aws-cdk/assert library?. This parameter is required.

Returns:

this

cdkAssertions

@Stability(value=Experimental)
public AwsCdkDeps.Builder cdkAssertions(Boolean cdkAssertions)

(experimental) Install the @aws-cdk/assertions library?

Only needed for CDK 1.x. If using CDK 2.x then assertions is already included in 'aws-cdk-lib'

Default: - will be included by default for AWS CDK >= 1.111.0 < 2.0.0

Parameters:

cdkAssertions - Install the @aws-cdk/assertions library?. This parameter is required.

Returns:

this

cdkDependencies

@Stability(value=Deprecated)
 @Deprecated
public AwsCdkDeps.Builder cdkDependencies(List<String> cdkDependencies)

Deprecated. For CDK 2.x use 'peerDeps' instead

(deprecated) Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?

Parameters:

cdkDependencies - Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?. This parameter is required.

Returns:

this

cdkDependenciesAsDeps

@Stability(value=Deprecated)
 @Deprecated
public AwsCdkDeps.Builder cdkDependenciesAsDeps(Boolean cdkDependenciesAsDeps)

Deprecated. Not supported in CDK v2.

(deprecated) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).

This is to ensure that downstream consumers actually have your CDK dependencies installed when using npm < 7 or yarn, where peer dependencies are not automatically installed. If this is disabled, cdkDependencies will be added to devDependencies to ensure they are present during development.

Default: true

Parameters:

cdkDependenciesAsDeps - If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). This parameter is required.

Returns:

this

cdkTestDependencies

@Stability(value=Deprecated)
 @Deprecated
public AwsCdkDeps.Builder cdkTestDependencies(List<String> cdkTestDependencies)

Deprecated. For CDK 2.x use 'devDeps' instead

(deprecated) AWS CDK modules required for testing.

Parameters:

cdkTestDependencies - AWS CDK modules required for testing. This parameter is required.

Returns:

this

cdkVersionPinning

@Stability(value=Experimental)
public AwsCdkDeps.Builder cdkVersionPinning(Boolean cdkVersionPinning)

(experimental) Use pinned version instead of caret version for CDK.

You can use this to prevent yarn to mix versions for your CDK dependencies and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

Parameters:

cdkVersionPinning - Use pinned version instead of caret version for CDK. This parameter is required.

Returns:

this

constructsVersion

@Stability(value=Experimental)
public AwsCdkDeps.Builder constructsVersion(String constructsVersion)

(experimental) Minimum version of the `constructs` library to depend on.

Default: - for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".

Parameters:

constructsVersion - Minimum version of the `constructs` library to depend on. This parameter is required.

Returns:

this

dependencyType

@Stability(value=Experimental)
public AwsCdkDeps.Builder dependencyType(DependencyType dependencyType)

(experimental) The type of dependency to use for runtime AWS CDK and `constructs` modules.

For libraries, use peer dependencies and for apps use runtime dependencies.

Parameters:

dependencyType - The type of dependency to use for runtime AWS CDK and `constructs` modules. This parameter is required.

Returns:

this

build

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

Specified by:

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