io.github.cdklabs.projen.awscdk

Class AwsCdkDepsOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.awscdk.AwsCdkDepsOptions.Jsii$Proxy

All Implemented Interfaces:

AwsCdkDepsCommonOptions, AwsCdkDepsOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

AwsCdkDepsOptions

@Stability(value=Experimental)
 @Internal
public static final class AwsCdkDepsOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements AwsCdkDepsOptions

An implementation for AwsCdkDepsOptions

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.awscdk.AwsCdkDepsOptions

AwsCdkDepsOptions.Builder, AwsCdkDepsOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(AwsCdkDepsOptions.Builder builder) Constructor that initializes the object based on literal property values passed by the AwsCdkDepsOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Boolean	getCdkAssert() (deprecated) Install the @aws-cdk/assert library?
Boolean	getCdkAssertions() (experimental) Install the @aws-cdk/assertions library?
List<String>	getCdkDependencies() (deprecated) Which AWS CDK modules (those that start with "@aws-cdk/") does this library require when consumed?
Boolean	getCdkDependenciesAsDeps() (deprecated) If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`).
List<String>	getCdkTestDependencies() (deprecated) AWS CDK modules required for testing.
String	getCdkVersion() (experimental) Minimum version of the AWS CDK to depend on.
Boolean	getCdkVersionPinning() (experimental) Use pinned version instead of caret version for CDK.
String	getConstructsVersion() (experimental) Minimum version of the `constructs` library to depend on.
DependencyType	getDependencyType() (experimental) The type of dependency to use for runtime AWS CDK and `constructs` modules.
int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.cdklabs.projen.awscdk.AwsCdkDepsOptions

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(AwsCdkDepsOptions.Builder builder)

Constructor that initializes the object based on literal property values passed by the AwsCdkDepsOptions.Builder.

Method Detail

getDependencyType

public final DependencyType getDependencyType()

Description copied from interface: AwsCdkDepsOptions

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

Specified by:

getDependencyType in interface AwsCdkDepsOptions

getCdkVersion

public final String getCdkVersion()

Description copied from interface: AwsCdkDepsCommonOptions

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

Default: "2.1.0"

Specified by:

getCdkVersion in interface AwsCdkDepsCommonOptions

getCdkAssert

public final Boolean getCdkAssert()

Description copied from interface: AwsCdkDepsCommonOptions

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

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

Specified by:

getCdkAssert in interface AwsCdkDepsCommonOptions

getCdkAssertions

public final Boolean getCdkAssertions()

Description copied from interface: AwsCdkDepsCommonOptions

(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

Specified by:

getCdkAssertions in interface AwsCdkDepsCommonOptions

getCdkDependencies

public final List<String> getCdkDependencies()

Description copied from interface: AwsCdkDepsCommonOptions

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

Specified by:

getCdkDependencies in interface AwsCdkDepsCommonOptions

getCdkDependenciesAsDeps

public final Boolean getCdkDependenciesAsDeps()

Description copied from interface: AwsCdkDepsCommonOptions

(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

Specified by:

getCdkDependenciesAsDeps in interface AwsCdkDepsCommonOptions

getCdkTestDependencies

public final List<String> getCdkTestDependencies()

Description copied from interface: AwsCdkDepsCommonOptions

(deprecated) AWS CDK modules required for testing.

Specified by:

getCdkTestDependencies in interface AwsCdkDepsCommonOptions

getCdkVersionPinning

public final Boolean getCdkVersionPinning()

Description copied from interface: AwsCdkDepsCommonOptions

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

Specified by:

getCdkVersionPinning in interface AwsCdkDepsCommonOptions

getConstructsVersion

public final String getConstructsVersion()

Description copied from interface: AwsCdkDepsCommonOptions

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

Specified by:

getConstructsVersion in interface AwsCdkDepsCommonOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object