AWS CDK Reference

Appearance

v2.273.0

HelmChartOptions Struct ​

Helm Chart options.

Source
aws-eks/lib/helm-chart.ts
Type last changed
v2.238.0 · 9 Feb 2026

Example ​

ts
import * as s3Assets from 'aws-cdk-lib/aws-s3-assets';

declare const cluster: eks.Cluster;
const chartAsset = new s3Assets.Asset(this, 'ChartAsset', {
  path: '/path/to/asset'
});

cluster.addHelmChart('test-chart', {
  chartAsset: chartAsset,
});

Properties ​

atomicbooleanatomicboolatomicBooleanAtomicboolAtomic*bool= false#
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.

chartstringchartstrchartStringChartstringChart*string= No chart name. Implies `chartAss…#
The name of the chart.

Either this or chartAsset must be specified.

default

Default: No chart name. Implies chartAsset is used.

chartAssetAssetchart_assetAssetchartAssetAssetChartAssetAssetChartAssetAsset= No chart asset. Implies `chart` …#
The chart in the form of an asset.

Either this or chart must be specified.

default

Default: No chart asset. Implies chart is used.

createNamespacebooleancreate_namespaceboolcreateNamespaceBooleanCreateNamespaceboolCreateNamespace*bool= true#
create namespace if not exist.
namespacestringnamespacestrnamespaceStringNamespacestringNamespace*string= default#
The Kubernetes namespace scope of the requests.
releasestringreleasestrreleaseStringReleasestringRelease*string= If no release name is given, it …#
The name of the release.
default

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

removalPolicyRemovalPolicyremoval_policyRemovalPolicyremovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicyRemovalPolicy= RemovalPolicy.DESTROY#
The removal policy applied to the custom resource that manages the Helm chart.
notes

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
repositorystringrepositorystrrepositoryStringRepositorystringRepository*string= No repository will be used, whic…#
The repository which contains the chart.

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

default

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

skipCrdsbooleanskip_crdsboolskipCrdsBooleanSkipCrdsboolSkipCrds*bool= CRDs are installed if not alread…#
if set, no CRDs will be installed.
default

Default: CRDs are installed if not already present

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Duration.minutes(5)#
Amount of time to wait for any individual Kubernetes operation.

Maximum 15 minutes.

values{ [key: string]: any }valuestyping.Mapping[str, Any]valuesMap<String, Object>ValuesIDictionary<string, object>Values*map[string]interface{}= No values are provided to the ch…#
The values to be used by the chart.

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

default

Default: No values are provided to the chart.

versionstringversionstrversionStringVersionstringVersion*string= If this is not specified, the la…#
The chart version to install.
default

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

waitbooleanwaitboolwaitBooleanWaitboolWait*bool= Helm will not wait before markin…#
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

Default: Helm will not wait before marking release as successful