io.github.cdklabs.projen.awscdk

Class AwsCdkDepsOptions.Builder

java.lang.Object

io.github.cdklabs.projen.awscdk.AwsCdkDepsOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<AwsCdkDepsOptions>

Enclosing interface:

AwsCdkDepsOptions

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

A builder for AwsCdkDepsOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AwsCdkDepsOptions	build() Builds the configured instance.
AwsCdkDepsOptions.Builder	cdkAssert(Boolean cdkAssert) Deprecated. The
AwsCdkDepsOptions.Builder	cdkAssertions(Boolean cdkAssertions) Sets the value of AwsCdkDepsCommonOptions.getCdkAssertions()
AwsCdkDepsOptions.Builder	cdkDependencies(List<String> cdkDependencies) Deprecated. For CDK 2.x use 'peerDeps' instead
AwsCdkDepsOptions.Builder	cdkDependenciesAsDeps(Boolean cdkDependenciesAsDeps) Deprecated. Not supported in CDK v2.
AwsCdkDepsOptions.Builder	cdkTestDependencies(List<String> cdkTestDependencies) Deprecated. For CDK 2.x use 'devDeps' instead
AwsCdkDepsOptions.Builder	cdkVersion(String cdkVersion) Sets the value of AwsCdkDepsCommonOptions.getCdkVersion()
AwsCdkDepsOptions.Builder	cdkVersionPinning(Boolean cdkVersionPinning) Sets the value of AwsCdkDepsCommonOptions.getCdkVersionPinning()
AwsCdkDepsOptions.Builder	constructsVersion(String constructsVersion) Sets the value of AwsCdkDepsCommonOptions.getConstructsVersion()
AwsCdkDepsOptions.Builder	dependencyType(DependencyType dependencyType) Sets the value of AwsCdkDepsOptions.getDependencyType()

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

dependencyType

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

Sets the value of AwsCdkDepsOptions.getDependencyType()

Parameters:

dependencyType - The type of dependency to use for runtime AWS CDK and `constructs` modules. This parameter is required. For libraries, use peer dependencies and for apps use runtime dependencies.

Returns:

this

cdkVersion

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

Sets the value of AwsCdkDepsCommonOptions.getCdkVersion()

Parameters:

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

Returns:

this

cdkAssert

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

Deprecated. The

Sets the value of AwsCdkDepsCommonOptions.getCdkAssert()

Parameters:

cdkAssert - Install the @aws-cdk/assert library?.

Returns:

this

cdkAssertions

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

Sets the value of AwsCdkDepsCommonOptions.getCdkAssertions()

Parameters:

cdkAssertions - 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'

Returns:

this

cdkDependencies

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

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

Sets the value of AwsCdkDepsCommonOptions.getCdkDependencies()

Parameters:

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

Returns:

this

cdkDependenciesAsDeps

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

Deprecated. Not supported in CDK v2.

Sets the value of AwsCdkDepsCommonOptions.getCdkDependenciesAsDeps()

Parameters:

cdkDependenciesAsDeps - 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.

Returns:

this

cdkTestDependencies

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

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

Sets the value of AwsCdkDepsCommonOptions.getCdkTestDependencies()

Parameters:

cdkTestDependencies - AWS CDK modules required for testing.

Returns:

this

cdkVersionPinning

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

Sets the value of AwsCdkDepsCommonOptions.getCdkVersionPinning()

Parameters:

cdkVersionPinning - 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.

Returns:

this

constructsVersion

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

Sets the value of AwsCdkDepsCommonOptions.getConstructsVersion()

Parameters:

constructsVersion - Minimum version of the `constructs` library to depend on.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of AwsCdkDepsOptions

Throws:

NullPointerException - if any required attribute was not provided