Package 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.126.0 (build 206d44b)", date="2026-02-09T14:39:10.754Z") @Stability(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());

  • Method Details

    • getAtomic

      @Stability(Stable) @Nullable default Boolean getAtomic()
      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(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(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(Stable) @Nullable default Boolean getCreateNamespace()
      create namespace if not exist.

      Default: true

    • getNamespace

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

      Default: default

    • getRelease

      @Stability(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.

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      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

      Default: RemovalPolicy.DESTROY

    • getRepository

      @Stability(Stable) @Nullable default String getRepository()
      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(Stable) @Nullable default Boolean getSkipCrds()
      if set, no CRDs will be installed.

      Default: - CRDs are installed if not already present

    • getTimeout

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

      Maximum 15 minutes.

      Default: Duration.minutes(5)

    • getValues

      @Stability(Stable) @Nullable default Map<String,Object> getValues()
      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(Stable) @Nullable default String getVersion()
      The chart version to install.

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

    • getWait

      @Stability(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(Stable) static HelmChartOptions.Builder builder()
      Returns:
      a HelmChartOptions.Builder of HelmChartOptions