Package io.github.cdklabs.projen.awscdk

Class AwsCdkDeps

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
    Direct Known Subclasses:
    AwsCdkDepsJava, AwsCdkDepsJs, AwsCdkDepsPy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.860Z")
@Stability(Experimental)
public abstract class AwsCdkDeps
extends Component
    (experimental) Manages dependencies on the AWS CDK.

    • Constructor Detail

      • AwsCdkDeps

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

      • AwsCdkDeps

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

      • AwsCdkDeps

        @Stability(Experimental)
protected AwsCdkDeps​(@NotNull
                     Project project,
                     @NotNull
                     AwsCdkDepsOptions options)
        Parameters:
        project - This parameter is required.
        options - This parameter is required.

    • Method Detail

      • addV1Dependencies

        @Stability(Experimental)
public void addV1Dependencies​(@NotNull
                              @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(Experimental)
public void addV1DevDependencies​(@NotNull
                                 @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 - fully qualified names of cdk modules (e.g. @aws-cdk/aws-lambda). This parameter is required.

      • packageNames

        @Stability(Experimental)
@NotNull
protected abstract AwsCdkPackageNames packageNames()
        (experimental) Return a configuration object with information about package naming in various languages.

      • preSynthesize

        @Stability(Experimental)
public void preSynthesize()
        (experimental) Called before synthesis.
        Overrides:
        preSynthesize in class Component

      • getCdkDependenciesAsDeps

        @Stability(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(Experimental)
@NotNull
public Number getCdkMajorVersion()
        (experimental) The major version of the AWS CDK (e.g. 1, 2, ...).

      • getCdkMinimumVersion

        @Stability(Experimental)
@NotNull
public String getCdkMinimumVersion()
        (experimental) The minimum version of the AWS CDK (e.g. 2.0.0).

      • getCdkVersion

        @Stability(Experimental)
@NotNull
public String getCdkVersion()
        (experimental) The dependency requirement for AWS CDK (e.g. ^2.0.0).