AWS CDK Reference

Appearance

v2.274.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 ​

atomicoptionalbooleanatomicoptionalboolatomicoptionalBooleanAtomicoptionalboolAtomicoptional*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.

chartoptionalstringchartoptionalstrchartoptionalStringChartoptionalstringChartoptional*string#
The name of the chart.

Default: No chart name. Implies chartAsset is used.

Either this or chartAsset must be specified.

chartAssetoptionalAssetchart_assetoptionalAssetchartAssetoptionalAssetChartAssetoptionalAssetChartAssetoptionalAsset#
The chart in the form of an asset.

Default: No chart asset. Implies chart is used.

Either this or chart must be specified.

createNamespaceoptionalbooleancreate_namespaceoptionalboolcreateNamespaceoptionalBooleanCreateNamespaceoptionalboolCreateNamespaceoptional*bool= true#
create namespace if not exist.
namespaceoptionalstringnamespaceoptionalstrnamespaceoptionalStringNamespaceoptionalstringNamespaceoptional*string= default#
The Kubernetes namespace scope of the requests.
releaseoptionalstringreleaseoptionalstrreleaseoptionalStringReleaseoptionalstringReleaseoptional*string#
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.

removalPolicyoptionalRemovalPolicyremoval_policyoptionalRemovalPolicyremovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicyRemovalPolicyoptionalRemovalPolicy= 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
repositoryoptionalstringrepositoryoptionalstrrepositoryoptionalStringRepositoryoptionalstringRepositoryoptional*string#
The repository which contains the chart.

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

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

skipCrdsoptionalbooleanskip_crdsoptionalboolskipCrdsoptionalBooleanSkipCrdsoptionalboolSkipCrdsoptional*bool#
if set, no CRDs will be installed.

Default: CRDs are installed if not already present

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

Maximum 15 minutes.

valuesoptional{ [key: string]: any }valuesoptionaltyping.Mapping[str, Any]valuesoptionalMap<String, Object>ValuesoptionalIDictionary<string, object>Valuesoptional*map[string]interface{}#
The values to be used by the chart.

Default: No values are provided to the chart.

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

versionoptionalstringversionoptionalstrversionoptionalStringVersionoptionalstringVersionoptional*string#
The chart version to install.

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

waitoptionalbooleanwaitoptionalboolwaitoptionalBooleanWaitoptionalboolWaitoptional*bool#
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