Package io.github.cdklabs.projen.cdk8s

Class Cdk8sDepsCommonOptions.Builder

java.lang.Object

io.github.cdklabs.projen.cdk8s.Cdk8sDepsCommonOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Cdk8sDepsCommonOptions>

Enclosing interface:

Cdk8sDepsCommonOptions

@Stability(Experimental)
public static final class Cdk8sDepsCommonOptions.Builder
extends Object
implements software.amazon.jsii.Builder<Cdk8sDepsCommonOptions>

A builder for Cdk8sDepsCommonOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Cdk8sDepsCommonOptions	build()	Builds the configured instance.
Cdk8sDepsCommonOptions.Builder	cdk8SCliVersion(String cdk8SCliVersion)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SCliVersion
Cdk8sDepsCommonOptions.Builder	cdk8SCliVersionPinning(Boolean cdk8SCliVersionPinning)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SCliVersionPinning
Cdk8sDepsCommonOptions.Builder	cdk8SPlus(Boolean cdk8SPlus)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SPlus
Cdk8sDepsCommonOptions.Builder	cdk8SPlusVersion(String cdk8SPlusVersion)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SPlusVersion
Cdk8sDepsCommonOptions.Builder	cdk8SPlusVersionPinning(Boolean cdk8SPlusVersionPinning)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SPlusVersionPinning
Cdk8sDepsCommonOptions.Builder	cdk8SVersion(String cdk8SVersion)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SVersion
Cdk8sDepsCommonOptions.Builder	cdk8SVersionPinning(Boolean cdk8SVersionPinning)	Sets the value of Cdk8sDepsCommonOptions#getCdk8SVersionPinning
Cdk8sDepsCommonOptions.Builder	constructsVersion(String constructsVersion)	Sets the value of Cdk8sDepsCommonOptions.getConstructsVersion()
Cdk8sDepsCommonOptions.Builder	constructsVersionPinning(Boolean constructsVersionPinning)	Sets the value of Cdk8sDepsCommonOptions.getConstructsVersionPinning()
Cdk8sDepsCommonOptions.Builder	k8SMinorVersion(Number k8SMinorVersion)	Sets the value of Cdk8sDepsCommonOptions#getK8SMinorVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

cdk8SVersion

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SVersion(String cdk8SVersion)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SVersion

Parameters:

cdk8SVersion - Minimum version of the cdk8s to depend on. This parameter is required.

Returns:

this

cdk8SCliVersion

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SCliVersion(String cdk8SCliVersion)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SCliVersion

Parameters:

cdk8SCliVersion - Minimum version of the cdk8s-cli to depend on.

Returns:

this

cdk8SCliVersionPinning

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SCliVersionPinning(Boolean cdk8SCliVersionPinning)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SCliVersionPinning

Parameters:

cdk8SCliVersionPinning - 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.

Returns:

this

cdk8SPlus

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SPlus(Boolean cdk8SPlus)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SPlus

Parameters:

cdk8SPlus - Include cdk8s-plus.

Returns:

this

cdk8SPlusVersion

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SPlusVersion(String cdk8SPlusVersion)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SPlusVersion

Parameters:

cdk8SPlusVersion - Minimum version of the cdk8s-plus-XX to depend on.

Returns:

this

cdk8SPlusVersionPinning

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SPlusVersionPinning(Boolean cdk8SPlusVersionPinning)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SPlusVersionPinning

Parameters:

cdk8SPlusVersionPinning - 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.

Returns:

this

cdk8SVersionPinning

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder cdk8SVersionPinning(Boolean cdk8SVersionPinning)

Sets the value of Cdk8sDepsCommonOptions#getCdk8SVersionPinning

Parameters:

cdk8SVersionPinning - 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.

Returns:

this

constructsVersion

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder constructsVersion(String constructsVersion)

Sets the value of Cdk8sDepsCommonOptions.getConstructsVersion()

Parameters:

constructsVersion - Minimum version of the constructs library to depend on.

Returns:

this

constructsVersionPinning

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder constructsVersionPinning(Boolean constructsVersionPinning)

Sets the value of Cdk8sDepsCommonOptions.getConstructsVersionPinning()

Parameters:

constructsVersionPinning - 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.

Returns:

this

k8SMinorVersion

@Stability(Experimental)
public Cdk8sDepsCommonOptions.Builder k8SMinorVersion(Number k8SMinorVersion)

Sets the value of Cdk8sDepsCommonOptions#getK8SMinorVersion

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.

Returns:

this

build

@Stability(Experimental)
public Cdk8sDepsCommonOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<Cdk8sDepsCommonOptions>

Returns:

a new instance of Cdk8sDepsCommonOptions

Throws:

NullPointerException - if any required attribute was not provided