Package io.github.cdklabs.projen.awscdk

Class AwsCdkDepsPy.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<AwsCdkDepsPy>
    Enclosing class:
    AwsCdkDepsPy
    @Stability(Experimental)
public static final class AwsCdkDepsPy.Builder
extends Object
implements software.amazon.jsii.Builder<AwsCdkDepsPy>
    (experimental) A fluent builder for AwsCdkDepsPy.

    • Method Detail

      • cdkVersion

        @Stability(Experimental)
public AwsCdkDepsPy.Builder cdkVersion​(String cdkVersion)
        (experimental) Minimum version of the AWS CDK to depend on.

        Default: "2.1.0"

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

      • cdkAssert

        @Stability(Deprecated)
@Deprecated
public AwsCdkDepsPy.Builder cdkAssert​(Boolean cdkAssert)
        Deprecated.
        The
        (deprecated) Warning: NodeJS only.

        Install the

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

        Parameters:
        cdkAssert - Warning: NodeJS only. This parameter is required.
        Returns:
        this

      • cdkAssertions

        @Stability(Experimental)
public AwsCdkDepsPy.Builder cdkAssertions​(Boolean cdkAssertions)
        (experimental) Install the 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

        Parameters:
        cdkAssertions - Install the assertions library?. This parameter is required.
        Returns:
        this

      • cdkDependencies

        @Stability(Deprecated)
@Deprecated
public AwsCdkDepsPy.Builder cdkDependencies​(List<String> cdkDependencies)
        Deprecated.
        For CDK 2.x use "deps" instead. (or "peerDeps" if you're building a library)
        (deprecated) Which AWS CDKv1 modules this project requires.

        Parameters:
        cdkDependencies - Which AWS CDKv1 modules this project requires. This parameter is required.
        Returns:
        this

      • cdkDependenciesAsDeps

        @Stability(Deprecated)
@Deprecated
public AwsCdkDepsPy.Builder cdkDependenciesAsDeps​(Boolean cdkDependenciesAsDeps)
        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.

        Note: this setting only applies to construct library projects

        Default: true

        Parameters:
        cdkDependenciesAsDeps - If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies). This parameter is required.
        Returns:
        this

      • cdkTestDependencies

        @Stability(Deprecated)
@Deprecated
public AwsCdkDepsPy.Builder cdkTestDependencies​(List<String> cdkTestDependencies)
        Deprecated.
        For CDK 2.x use 'devDeps' (in node.js projects) or 'testDeps' (in java projects) instead
        (deprecated) AWS CDK modules required for testing.

        Parameters:
        cdkTestDependencies - AWS CDK modules required for testing. This parameter is required.
        Returns:
        this

      • cdkVersionPinning

        @Stability(Experimental)
public AwsCdkDepsPy.Builder cdkVersionPinning​(Boolean cdkVersionPinning)
        (experimental) Use pinned version instead of caret version for CDK.

        You can use this to prevent mixed 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.

        Parameters:
        cdkVersionPinning - Use pinned version instead of caret version for CDK. This parameter is required.
        Returns:
        this

      • constructsVersion

        @Stability(Experimental)
public AwsCdkDepsPy.Builder constructsVersion​(String constructsVersion)
        (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".

        Parameters:
        constructsVersion - Minimum version of the constructs library to depend on. This parameter is required.
        Returns:
        this

      • dependencyType

        @Stability(Experimental)
public AwsCdkDepsPy.Builder dependencyType​(DependencyType dependencyType)
        (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.

        Parameters:
        dependencyType - The type of dependency to use for runtime AWS CDK and constructs modules. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public AwsCdkDepsPy build()
        Specified by:
        build in interface software.amazon.jsii.Builder<AwsCdkDepsPy>
        Returns:
        a newly built instance of AwsCdkDepsPy.