Package software.amazon.awscdk.services.eks.v2.alpha

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.125.0 (build fdbe357)", date="2026-01-19T12:04:05.618Z") @Stability(Experimental) public interface HelmChartOptions extends software.amazon.jsii.JsiiSerializable
(experimental) 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());

  • Method Details

    • getAtomic

      @Stability(Experimental) @Nullable default Boolean getAtomic()
      (experimental) 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.

      Default: false

    • getChart

      @Stability(Experimental) @Nullable default String getChart()
      (experimental) The name of the chart.

      Either this or chartAsset must be specified.

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

    • getChartAsset

      @Stability(Experimental) @Nullable default Asset getChartAsset()
      (experimental) 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(Experimental) @Nullable default Boolean getCreateNamespace()
      (experimental) create namespace if not exist.

      Default: true

    • getNamespace

      @Stability(Experimental) @Nullable default String getNamespace()
      (experimental) The Kubernetes namespace scope of the requests.

      Default: default

    • getRelease

      @Stability(Experimental) @Nullable default String getRelease()
      (experimental) 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(Experimental) @Nullable default String getRepository()
      (experimental) The repository which contains the chart.

      For example: https://charts.helm.sh/stable/

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

    • getSkipCrds

      @Stability(Experimental) @Nullable default Boolean getSkipCrds()
      (experimental) if set, no CRDs will be installed.

      Default: - CRDs are installed if not already present

    • getTimeout

      @Stability(Experimental) @Nullable default Duration getTimeout()
      (experimental) Amount of time to wait for any individual Kubernetes operation.

      Maximum 15 minutes.

      Default: Duration.minutes(5)

    • getValues

      @Stability(Experimental) @Nullable default Map<String,Object> getValues()
      (experimental) The values to be used by the chart.

      For nested values use a nested dictionary. For example: values: { installationCRDs: true, webhook: { port: 9443 } }

      Default: - No values are provided to the chart.

    • getVersion

      @Stability(Experimental) @Nullable default String getVersion()
      (experimental) The chart version to install.

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

    • getWait

      @Stability(Experimental) @Nullable default Boolean getWait()
      (experimental) 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(Experimental) static HelmChartOptions.Builder builder()
      Returns:
      a HelmChartOptions.Builder of HelmChartOptions