Package io.github.cdklabs.projen.cdk8s

Class Cdk8sDepsPy.Builder

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

    • Method Detail

      • cdk8SVersion

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SVersion​(String cdk8SVersion)
        (experimental) Minimum version of the cdk8s to depend on.

        Default: "2.3.33"

        Parameters:
        cdk8SVersion - Minimum version of the cdk8s to depend on. This parameter is required.
        Returns:
        this

      • cdk8SCliVersion

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SCliVersion​(String cdk8SCliVersion)
        (experimental) Minimum version of the cdk8s-cli to depend on.

        Default: "2.0.28"

        Parameters:
        cdk8SCliVersion - Minimum version of the cdk8s-cli to depend on. This parameter is required.
        Returns:
        this

      • cdk8SCliVersionPinning

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SCliVersionPinning​(Boolean cdk8SCliVersionPinning)
        (experimental) Use pinned version instead of caret version for cdk8s-cli.

        You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

        Parameters:
        cdk8SCliVersionPinning - Use pinned version instead of caret version for cdk8s-cli. This parameter is required.
        Returns:
        this

      • cdk8SPlus

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SPlus​(Boolean cdk8SPlus)
        (experimental) Include cdk8s-plus.

        Default: true

        Parameters:
        cdk8SPlus - Include cdk8s-plus. This parameter is required.
        Returns:
        this

      • cdk8SPlusVersion

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SPlusVersion​(String cdk8SPlusVersion)
        (experimental) Minimum version of the cdk8s-plus-XX to depend on.

        Default: "2.0.0-rc.26"

        Parameters:
        cdk8SPlusVersion - Minimum version of the cdk8s-plus-XX to depend on. This parameter is required.
        Returns:
        this

      • cdk8SPlusVersionPinning

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SPlusVersionPinning​(Boolean cdk8SPlusVersionPinning)
        (experimental) Use pinned version instead of caret version for cdk8s-plus-17.

        You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

        Parameters:
        cdk8SPlusVersionPinning - Use pinned version instead of caret version for cdk8s-plus-17. This parameter is required.
        Returns:
        this

      • cdk8SVersionPinning

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SVersionPinning​(Boolean cdk8SVersionPinning)
        (experimental) Use pinned version instead of caret version for cdk8s.

        You can use this to prevent yarn to mix versions for your CDK8s package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

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

      • constructsVersion

        @Stability(Experimental)
public Cdk8sDepsPy.Builder constructsVersion​(String constructsVersion)
        (experimental) Minimum version of the constructs library to depend on.

        Default: "10.1.42"

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

      • constructsVersionPinning

        @Stability(Experimental)
public Cdk8sDepsPy.Builder constructsVersionPinning​(Boolean constructsVersionPinning)
        (experimental) Use pinned version instead of caret version for constructs.

        You can use this to prevent yarn to mix versions for your consructs package and to prevent auto-updates. If you use experimental features this will let you define the moment you include breaking changes.

        Default: false

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

      • k8SMinorVersion

        @Stability(Experimental)
public Cdk8sDepsPy.Builder k8SMinorVersion​(Number k8SMinorVersion)
        (experimental) The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0.

        Default: 22

        Parameters:
        k8SMinorVersion - The cdk8s-plus library depends of Kubernetes minor version For example, cdk8s-plus-22 targets kubernetes version 1.22.0 cdk8s-plus-21 targets kubernetes version 1.21.0. This parameter is required.
        Returns:
        this

      • cdk8SCliDependency

        @Stability(Experimental)
public Cdk8sDepsPy.Builder cdk8SCliDependency​(Boolean cdk8SCliDependency)
        (experimental) Add cdk8s-cli only to Node projects.

        Default: false

        Parameters:
        cdk8SCliDependency - Add cdk8s-cli only to Node projects. This parameter is required.
        Returns:
        this

      • dependencyType

        @Stability(Experimental)
public Cdk8sDepsPy.Builder dependencyType​(DependencyType dependencyType)
        (experimental) The type of dependency to use for runtime CDK8s and constructs modules.

        For libraries, use peer dependencies and for apps use runtime dependencies.

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

      • build

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