HelmChart
Represents a helm chart within the Kubernetes system. Applies/deletes the resources using `kubectl` in sync with the resource.
Import
import { HelmChart } from 'aws-cdk-lib/aws-eks';Or use the module namespace:
import * as eks from 'aws-cdk-lib/aws-eks';
// eks.HelmChartProperties
Configuration passed to the constructor as HelmChartProps.
clusterRequiredIClusterThe EKS cluster to apply this configuration to. [disable-awslint:ref-via-interface]
13 properties inherited from HelmChartOptions
atomicOptionalinherited from HelmChartOptionsbooleanWhether 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
chartOptionalinherited from HelmChartOptionsstringThe name of the chart. Either this or `chartAsset` must be specified.
Default: - No chart name. Implies `chartAsset` is used.
chartAssetOptionalinherited from HelmChartOptionsAssetThe chart in the form of an asset. Either this or `chart` must be specified.
Default: - No chart asset. Implies `chart` is used.
createNamespaceOptionalinherited from HelmChartOptionsbooleancreate namespace if not exist.
Default: true
namespaceOptionalinherited from HelmChartOptionsstringThe Kubernetes namespace scope of the requests.
Default: default
releaseOptionalinherited from HelmChartOptionsstringThe name of the release.
Default: - If no release name is given, it will use the last 53 characters of the node's unique id.
removalPolicyOptionalinherited from HelmChartOptionsRemovalPolicyThe 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
repositoryOptionalinherited from HelmChartOptionsstringThe 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.
skipCrdsOptionalinherited from HelmChartOptionsbooleanif set, no CRDs will be installed.
Default: - CRDs are installed if not already present
timeoutOptionalinherited from HelmChartOptionsDurationAmount of time to wait for any individual Kubernetes operation. Maximum 15 minutes.
Default: Duration.minutes(5)
valuesOptionalinherited from HelmChartOptions{ [key: string]: any }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.
versionOptionalinherited from HelmChartOptionsstringThe chart version to install.
Default: - If this is not specified, the latest version is installed
waitOptionalinherited from HelmChartOptionsbooleanWhether 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
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-eks