software.amazon.awscdk.services.eks

Interface HelmChartOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

HelmChartProps

All Known Implementing Classes:

HelmChartOptions.Jsii$Proxy, HelmChartProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.937Z")
 @Stability(value=Stable)
public interface HelmChartOptions
extends software.amazon.jsii.JsiiSerializable

Helm Chart options.

Example:

 import software.amazon.awscdk.services.s3.assets.*;
 Cluster cluster;
 Asset chartAsset = Asset.Builder.create(this, "ChartAsset")
         .path("/path/to/asset")
         .build();
 cluster.addHelmChart("test-chart", HelmChartOptions.builder()
         .chartAsset(chartAsset)
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HelmChartOptions.Builder	builder()
default String	getChart() The name of the chart.
default Asset	getChartAsset() The chart in the form of an asset.
default Boolean	getCreateNamespace() create namespace if not exist.
default String	getNamespace() The Kubernetes namespace scope of the requests.
default String	getRelease() The name of the release.
default String	getRepository() The repository which contains the chart.
default Duration	getTimeout() Amount of time to wait for any individual Kubernetes operation.
default Map<String,Object>	getValues() The values to be used by the chart.
default String	getVersion() The chart version to install.
default Boolean	getWait() 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 interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChart

@Stability(value=Stable)
 @Nullable
default String getChart()

The name of the chart.

Either this or chartAsset must be specified.

Default: - No chart name. Implies `chartAsset` is used.

getChartAsset

@Stability(value=Stable)
 @Nullable
default Asset getChartAsset()

The chart in the form of an asset.

Either this or chart must be specified.

Default: - No chart asset. Implies `chart` is used.

getCreateNamespace

@Stability(value=Stable)
 @Nullable
default Boolean getCreateNamespace()

create namespace if not exist.

Default: true

getNamespace

@Stability(value=Stable)
 @Nullable
default String getNamespace()

The Kubernetes namespace scope of the requests.

Default: default

getRelease

@Stability(value=Stable)
 @Nullable
default String getRelease()

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.

getRepository

@Stability(value=Stable)
 @Nullable
default String getRepository()

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.

getTimeout

@Stability(value=Stable)
 @Nullable
default Duration getTimeout()

Amount of time to wait for any individual Kubernetes operation.

Maximum 15 minutes.

Default: Duration.minutes(5)

getValues

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getValues()

The values to be used by the chart.

Default: - No values are provided to the chart.

getVersion

@Stability(value=Stable)
 @Nullable
default String getVersion()

The chart version to install.

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

getWait

@Stability(value=Stable)
 @Nullable
default Boolean getWait()

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

builder

@Stability(value=Stable)
static HelmChartOptions.Builder builder()

Returns:

a HelmChartOptions.Builder of HelmChartOptions