Package software.amazon.awscdk.services.eks

Class HelmChartProps.Builder

java.lang.Object

software.amazon.awscdk.services.eks.HelmChartProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HelmChartProps>

Enclosing interface:

HelmChartProps

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

A builder for HelmChartProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HelmChartProps.Builder	atomic(Boolean atomic)	Sets the value of HelmChartOptions.getAtomic()
HelmChartProps	build()	Builds the configured instance.
HelmChartProps.Builder	chart(String chart)	Sets the value of HelmChartOptions.getChart()
HelmChartProps.Builder	chartAsset(Asset chartAsset)	Sets the value of HelmChartOptions.getChartAsset()
HelmChartProps.Builder	cluster(ICluster cluster)	Sets the value of HelmChartProps.getCluster()
HelmChartProps.Builder	createNamespace(Boolean createNamespace)	Sets the value of HelmChartOptions.getCreateNamespace()
HelmChartProps.Builder	namespace(String namespace)	Sets the value of HelmChartOptions.getNamespace()
HelmChartProps.Builder	release(String release)	Sets the value of HelmChartOptions.getRelease()
HelmChartProps.Builder	repository(String repository)	Sets the value of HelmChartOptions.getRepository()
HelmChartProps.Builder	skipCrds(Boolean skipCrds)	Sets the value of HelmChartOptions.getSkipCrds()
HelmChartProps.Builder	timeout(Duration timeout)	Sets the value of HelmChartOptions.getTimeout()
HelmChartProps.Builder	values(Map<String,? extends Object> values)	Sets the value of HelmChartOptions.getValues()
HelmChartProps.Builder	version(String version)	Sets the value of HelmChartOptions.getVersion()
HelmChartProps.Builder	wait(Boolean wait)	Sets the value of HelmChartOptions.getWait()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

cluster

@Stability(Stable)
public HelmChartProps.Builder cluster(ICluster cluster)

Sets the value of HelmChartProps.getCluster()

Parameters:

cluster - The EKS cluster to apply this configuration to. This parameter is required. [disable-awslint:ref-via-interface]

Returns:

this

atomic

@Stability(Stable)
public HelmChartProps.Builder atomic(Boolean atomic)

Sets the value of HelmChartOptions.getAtomic()

Parameters:

atomic - Whether or not Helm should treat this operation as atomic;. if set, upgrade process rolls back changes made in case of failed upgrade. The --wait flag will be set automatically if --atomic is used.

Returns:

this

chart

@Stability(Stable)
public HelmChartProps.Builder chart(String chart)

Sets the value of HelmChartOptions.getChart()

Parameters:

chart - The name of the chart. Either this or chartAsset must be specified.

Returns:

this

chartAsset

@Stability(Stable)
public HelmChartProps.Builder chartAsset(Asset chartAsset)

Sets the value of HelmChartOptions.getChartAsset()

Parameters:

chartAsset - The chart in the form of an asset. Either this or chart must be specified.

Returns:

this

createNamespace

@Stability(Stable)
public HelmChartProps.Builder createNamespace(Boolean createNamespace)

Sets the value of HelmChartOptions.getCreateNamespace()

Parameters:

createNamespace - create namespace if not exist.

Returns:

this

namespace

@Stability(Stable)
public HelmChartProps.Builder namespace(String namespace)

Sets the value of HelmChartOptions.getNamespace()

Parameters:

namespace - The Kubernetes namespace scope of the requests.

Returns:

this

release

@Stability(Stable)
public HelmChartProps.Builder release(String release)

Sets the value of HelmChartOptions.getRelease()

Parameters:

release - The name of the release.

Returns:

this

repository

@Stability(Stable)
public HelmChartProps.Builder repository(String repository)

Sets the value of HelmChartOptions.getRepository()

Parameters:

repository - The repository which contains the chart. For example: https://charts.helm.sh/stable/

Returns:

this

skipCrds

@Stability(Stable)
public HelmChartProps.Builder skipCrds(Boolean skipCrds)

Sets the value of HelmChartOptions.getSkipCrds()

Parameters:

skipCrds - if set, no CRDs will be installed.

Returns:

this

timeout

@Stability(Stable)
public HelmChartProps.Builder timeout(Duration timeout)

Sets the value of HelmChartOptions.getTimeout()

Parameters:

timeout - Amount of time to wait for any individual Kubernetes operation. Maximum 15 minutes.

Returns:

this

values

@Stability(Stable)
public HelmChartProps.Builder values(Map<String,? extends Object> values)

Sets the value of HelmChartOptions.getValues()

Parameters:

values - The values to be used by the chart. For nested values use a nested dictionary. For example: values: { installationCRDs: true, webhook: { port: 9443 } }

Returns:

this

version

@Stability(Stable)
public HelmChartProps.Builder version(String version)

Sets the value of HelmChartOptions.getVersion()

Parameters:

version - The chart version to install.

Returns:

this

wait

@Stability(Stable)
public HelmChartProps.Builder wait(Boolean wait)

Sets the value of HelmChartOptions.getWait()

Parameters:

wait - Whether or not Helm should wait until all Pods, PVCs, Services, and minimum number of Pods of a Deployment, StatefulSet, or ReplicaSet are in a ready state before marking the release as successful.

Returns:

this

build

@Stability(Stable)
public HelmChartProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HelmChartProps

Throws:

NullPointerException - if any required attribute was not provided