io.github.cdklabs.projen.awscdk

Class AwsCdkDeps

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.awscdk.AwsCdkDeps

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.492Z")
 @Stability(value=Experimental)
public class AwsCdkDeps
extends Component

(experimental) Manages dependencies on the AWS CDK.

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsCdkDeps(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	AwsCdkDeps(software.amazon.jsii.JsiiObjectRef objRef)
	AwsCdkDeps(Project project, AwsCdkDepsOptions options)

Method Summary

Modifier and Type	Method and Description
void	addV1Dependencies(String... deps) (experimental) Adds dependencies to AWS CDK modules.
void	addV1DevDependencies(String... deps) (experimental) Adds AWS CDK modules as dev dependencies.
Boolean	getCdkDependenciesAsDeps() Deprecated. Not used for CDK 2.x
Number	getCdkMajorVersion() (experimental) The major version of the AWS CDK (e.g.
String	getCdkMinimumVersion() (experimental) The minimum version of the AWS CDK (e.g.
String	getCdkVersion() (experimental) The dependency requirement for AWS CDK (e.g.

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

getProject, postSynthesize, preSynthesize, synthesize

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

AwsCdkDeps

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

AwsCdkDeps

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

AwsCdkDeps

@Stability(value=Experimental)
public AwsCdkDeps(@NotNull
                                                 Project project,
                                                 @NotNull
                                                 AwsCdkDepsOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

addV1Dependencies

@Stability(value=Experimental)
public void addV1Dependencies(@NotNull
                                                             String... deps)

(experimental) Adds dependencies to AWS CDK modules.

The type of dependency is determined by the dependencyType option.

This method is not supported in CDK v2. Use project.addPeerDeps() or project.addDeps() as appropriate.

Parameters:

deps - names of cdk modules (e.g. `@aws-cdk/aws-lambda`). This parameter is required.

addV1DevDependencies

@Stability(value=Experimental)
public void addV1DevDependencies(@NotNull
                                                                String... deps)

(experimental) Adds AWS CDK modules as dev dependencies.

This method is not supported in CDK v2. Use project.addPeerDeps() or project.addDeps() as appropriate.

Parameters:

deps - names of cdk modules (e.g. `@aws-cdk/aws-lambda`). This parameter is required.

getCdkDependenciesAsDeps

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Boolean getCdkDependenciesAsDeps()

Deprecated. Not used for CDK 2.x

(deprecated) Whether CDK dependencies are added as normal dependencies (and peer dependencies).

getCdkMajorVersion

@Stability(value=Experimental)
 @NotNull
public Number getCdkMajorVersion()

(experimental) The major version of the AWS CDK (e.g. 1, 2, ...).

getCdkMinimumVersion

@Stability(value=Experimental)
 @NotNull
public String getCdkMinimumVersion()

(experimental) The minimum version of the AWS CDK (e.g. `2.0.0`).

getCdkVersion

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

(experimental) The dependency requirement for AWS CDK (e.g. `^2.0.0`).