software.amazon.awscdk.services.eks

Class HelmChart.Builder

java.lang.Object

software.amazon.awscdk.services.eks.HelmChart.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HelmChart>

Enclosing class:

HelmChart

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

A fluent builder for HelmChart.

Method Summary

Modifier and Type	Method and Description
HelmChart	build()
HelmChart.Builder	chart(String chart) The name of the chart.
HelmChart.Builder	cluster(ICluster cluster) The EKS cluster to apply this configuration to.
static HelmChart.Builder	create(software.constructs.Construct scope, String id)
HelmChart.Builder	createNamespace(Boolean createNamespace) create namespace if not exist.
HelmChart.Builder	namespace(String namespace) The Kubernetes namespace scope of the requests.
HelmChart.Builder	release(String release) The name of the release.
HelmChart.Builder	repository(String repository) The repository which contains the chart.
HelmChart.Builder	timeout(Duration timeout) Amount of time to wait for any individual Kubernetes operation.
HelmChart.Builder	values(Map<String,? extends Object> values) The values to be used by the chart.
HelmChart.Builder	version(String version) The chart version to install.
HelmChart.Builder	wait(Boolean 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.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static HelmChart.Builder create(software.constructs.Construct scope,
                                                                String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of HelmChart.Builder.

chart

@Stability(value=Stable)
public HelmChart.Builder chart(String chart)

The name of the chart.

Parameters:

chart - The name of the chart. This parameter is required.

Returns:

this

createNamespace

@Stability(value=Stable)
public HelmChart.Builder createNamespace(Boolean createNamespace)

create namespace if not exist.

Default: true

Parameters:

createNamespace - create namespace if not exist. This parameter is required.

Returns:

this

namespace

@Stability(value=Stable)
public HelmChart.Builder namespace(String namespace)

The Kubernetes namespace scope of the requests.

Default: default

Parameters:

namespace - The Kubernetes namespace scope of the requests. This parameter is required.

Returns:

this

release

@Stability(value=Stable)
public HelmChart.Builder release(String release)

The name of the release.

Default: - If no release name is given, it will use the last 53 characters of the node's unique id.

Parameters:

release - The name of the release. This parameter is required.

Returns:

this

repository

@Stability(value=Stable)
public HelmChart.Builder repository(String repository)

The repository which contains the chart.

For example: https://kubernetes-charts.storage.googleapis.com/

Default: - No repository will be used, which means that the chart needs to be an absolute URL.

Parameters:

repository - The repository which contains the chart. This parameter is required.

Returns:

this

timeout

@Stability(value=Stable)
public HelmChart.Builder timeout(Duration timeout)

Amount of time to wait for any individual Kubernetes operation.

Maximum 15 minutes.

Default: Duration.minutes(5)

Parameters:

timeout - Amount of time to wait for any individual Kubernetes operation. This parameter is required.

Returns:

this

values

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

The values to be used by the chart.

Default: - No values are provided to the chart.

Parameters:

values - The values to be used by the chart. This parameter is required.

Returns:

this

version

@Stability(value=Stable)
public HelmChart.Builder version(String version)

The chart version to install.

Default: - If this is not specified, the latest version is installed

Parameters:

version - The chart version to install. This parameter is required.

Returns:

this

wait

@Stability(value=Stable)
public HelmChart.Builder wait(Boolean 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.

Default: - Helm will not wait before marking release as successful

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. This parameter is required.

Returns:

this

cluster

@Stability(value=Stable)
public HelmChart.Builder cluster(ICluster cluster)

The EKS cluster to apply this configuration to.

[disable-awslint:ref-via-interface]

Parameters:

cluster - The EKS cluster to apply this configuration to. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public HelmChart build()

Specified by:

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