io.github.cdklabs.projen.awscdk

Interface AwsCdkDepsCommonOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, AwsCdkDepsOptions, AwsCdkTypeScriptAppOptions, ConstructLibraryAwsOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, AwsCdkDepsCommonOptions.Jsii$Proxy, AwsCdkDepsOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.494Z")
 @Stability(value=Experimental)
public interface AwsCdkDepsCommonOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for `AwsCdkDeps`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AwsCdkDepsCommonOptions.Builder	builder()
default Boolean	getCdkAssert() Deprecated. The
default Boolean	getCdkAssertions() (experimental) Install the @aws-cdk/assertions library?
default List<String>	getCdkDependencies() Deprecated. For CDK 2.x use 'peerDeps' instead
default Boolean	getCdkDependenciesAsDeps() Deprecated. Not supported in CDK v2.
default List<String>	getCdkTestDependencies() Deprecated. For CDK 2.x use 'devDeps' instead
String	getCdkVersion() (experimental) Minimum version of the AWS CDK to depend on.
default Boolean	getCdkVersionPinning() (experimental) Use pinned version instead of caret version for CDK.
default String	getConstructsVersion() (experimental) Minimum version of the `constructs` library to depend on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCdkVersion

@Stability(value=Experimental)
 @NotNull
String getCdkVersion()

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

Default: "2.1.0"

getCdkAssert

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getCdkAssert()

Deprecated. The

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

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

getCdkAssertions

@Stability(value=Experimental)
 @Nullable
default Boolean getCdkAssertions()

(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

getCdkDependencies

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<String> getCdkDependencies()

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?

getCdkDependenciesAsDeps

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Boolean getCdkDependenciesAsDeps()

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

getCdkTestDependencies

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<String> getCdkTestDependencies()

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

(deprecated) AWS CDK modules required for testing.

getCdkVersionPinning

@Stability(value=Experimental)
 @Nullable
default Boolean getCdkVersionPinning()

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

getConstructsVersion

@Stability(value=Experimental)
 @Nullable
default String getConstructsVersion()

(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".

builder

@Stability(value=Experimental)
static AwsCdkDepsCommonOptions.Builder builder()

Returns:

a AwsCdkDepsCommonOptions.Builder of AwsCdkDepsCommonOptions