Package software.amazon.awscdk.services.eks

Class HelmChartOptions.Builder

java.lang.Object

software.amazon.awscdk.services.eks.HelmChartOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HelmChartOptions>

Enclosing interface:

HelmChartOptions

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

A builder for HelmChartOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HelmChartOptions.Builder	atomic(Boolean atomic)	Sets the value of HelmChartOptions.getAtomic()
HelmChartOptions	build()	Builds the configured instance.
HelmChartOptions.Builder	chart(String chart)	Sets the value of HelmChartOptions.getChart()
HelmChartOptions.Builder	chartAsset(Asset chartAsset)	Sets the value of HelmChartOptions.getChartAsset()
HelmChartOptions.Builder	createNamespace(Boolean createNamespace)	Sets the value of HelmChartOptions.getCreateNamespace()
HelmChartOptions.Builder	namespace(String namespace)	Sets the value of HelmChartOptions.getNamespace()
HelmChartOptions.Builder	release(String release)	Sets the value of HelmChartOptions.getRelease()
HelmChartOptions.Builder	removalPolicy(RemovalPolicy removalPolicy)	Sets the value of HelmChartOptions.getRemovalPolicy()
HelmChartOptions.Builder	repository(String repository)	Sets the value of HelmChartOptions.getRepository()
HelmChartOptions.Builder	skipCrds(Boolean skipCrds)	Sets the value of HelmChartOptions.getSkipCrds()
HelmChartOptions.Builder	timeout(Duration timeout)	Sets the value of HelmChartOptions.getTimeout()
HelmChartOptions.Builder	values(Map<String,? extends Object> values)	Sets the value of HelmChartOptions.getValues()
HelmChartOptions.Builder	version(String version)	Sets the value of HelmChartOptions.getVersion()
HelmChartOptions.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

atomic

@Stability(Stable)
public HelmChartOptions.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 HelmChartOptions.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 HelmChartOptions.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 HelmChartOptions.Builder createNamespace(Boolean createNamespace)

Sets the value of HelmChartOptions.getCreateNamespace()

Parameters:

createNamespace - create namespace if not exist.

Returns:

this

namespace

@Stability(Stable)
public HelmChartOptions.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 HelmChartOptions.Builder release(String release)

Sets the value of HelmChartOptions.getRelease()

Parameters:

release - The name of the release.

Returns:

this

removalPolicy

@Stability(Stable)
public HelmChartOptions.Builder removalPolicy(RemovalPolicy removalPolicy)

Sets the value of HelmChartOptions.getRemovalPolicy()

Parameters:

removalPolicy - The removal policy applied to the custom resource that manages the Helm chart. The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
• The stack is deleted, so CloudFormation stops managing all resources in it

Returns:

this

repository

@Stability(Stable)
public HelmChartOptions.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 HelmChartOptions.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 HelmChartOptions.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 HelmChartOptions.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 HelmChartOptions.Builder version(String version)

Sets the value of HelmChartOptions.getVersion()

Parameters:

version - The chart version to install.

Returns:

this

wait

@Stability(Stable)
public HelmChartOptions.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 HelmChartOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HelmChartOptions

Throws:

NullPointerException - if any required attribute was not provided