Package io.github.cdklabs.projen.cdk8s

Interface Cdk8sDepsCommonOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

Cdk8sDepsOptions, Cdk8sPythonOptions, Cdk8sTypeScriptAppOptions

All Known Implementing Classes:

Cdk8sDepsCommonOptions.Jsii$Proxy, Cdk8sDepsOptions.Jsii$Proxy, Cdk8sPythonOptions.Jsii$Proxy, Cdk8sTypeScriptAppOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.995Z")
@Stability(Experimental)
public interface Cdk8sDepsCommonOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for Cdk8sDeps.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Cdk8sDepsCommonOptions.Builder	A builder for Cdk8sDepsCommonOptions
static class	Cdk8sDepsCommonOptions.Jsii$Proxy	An implementation for Cdk8sDepsCommonOptions

Method Summary

Modifier and Type	Method	Description
static Cdk8sDepsCommonOptions.Builder	builder()
default String	getCdk8sCliVersion()	(experimental) Minimum version of the cdk8s-cli to depend on.
default Boolean	getCdk8sCliVersionPinning()	(experimental) Use pinned version instead of caret version for cdk8s-cli.
default Boolean	getCdk8sPlus()	(experimental) Include cdk8s-plus.
default String	getCdk8sPlusVersion()	(experimental) Minimum version of the cdk8s-plus-XX to depend on.
default Boolean	getCdk8sPlusVersionPinning()	(experimental) Use pinned version instead of caret version for cdk8s-plus-17.
String	getCdk8sVersion()	(experimental) Minimum version of the cdk8s to depend on.
default Boolean	getCdk8sVersionPinning()	(experimental) Use pinned version instead of caret version for cdk8s.
default String	getConstructsVersion()	(experimental) Minimum version of the constructs library to depend on.
default Boolean	getConstructsVersionPinning()	(experimental) Use pinned version instead of caret version for constructs.
default Number	getK8sMinorVersion()	(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.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCdk8sVersion

@Stability(Experimental)
@NotNull
String getCdk8sVersion()

(experimental) Minimum version of the cdk8s to depend on.

Default: "2.3.33"

getCdk8sCliVersion

@Stability(Experimental)
@Nullable
default String getCdk8sCliVersion()

(experimental) Minimum version of the cdk8s-cli to depend on.

Default: "2.0.28"

getCdk8sCliVersionPinning

@Stability(Experimental)
@Nullable
default Boolean getCdk8sCliVersionPinning()

(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

getCdk8sPlus

@Stability(Experimental)
@Nullable
default Boolean getCdk8sPlus()

(experimental) Include cdk8s-plus.

Default: true

getCdk8sPlusVersion

@Stability(Experimental)
@Nullable
default String getCdk8sPlusVersion()

(experimental) Minimum version of the cdk8s-plus-XX to depend on.

Default: "2.0.0-rc.26"

getCdk8sPlusVersionPinning

@Stability(Experimental)
@Nullable
default Boolean getCdk8sPlusVersionPinning()

(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

getCdk8sVersionPinning

@Stability(Experimental)
@Nullable
default Boolean getCdk8sVersionPinning()

(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

getConstructsVersion

@Stability(Experimental)
@Nullable
default String getConstructsVersion()

(experimental) Minimum version of the constructs library to depend on.

Default: "10.1.42"

getConstructsVersionPinning

@Stability(Experimental)
@Nullable
default Boolean getConstructsVersionPinning()

(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

getK8sMinorVersion

@Stability(Experimental)
@Nullable
default Number getK8sMinorVersion()

(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

builder

@Stability(Experimental)
static Cdk8sDepsCommonOptions.Builder builder()

Returns:

a Cdk8sDepsCommonOptions.Builder of Cdk8sDepsCommonOptions