aws-cdk-lib.aws_eks.HelmChartOptions

interface HelmChartOptions

LanguageType name
.NETAmazon.CDK.AWS.EKS.HelmChartOptions
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awseks#HelmChartOptions
Javasoftware.amazon.awscdk.services.eks.HelmChartOptions
Pythonaws_cdk.aws_eks.HelmChartOptions
TypeScript (source)aws-cdk-lib » aws_eks » HelmChartOptions

Helm Chart options.

Example

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

NameTypeDescription
chart?stringThe name of the chart.
chartAsset?AssetThe chart in the form of an asset.
createNamespace?booleancreate namespace if not exist.
namespace?stringThe Kubernetes namespace scope of the requests.
release?stringThe name of the release.
repository?stringThe repository which contains the chart.
skipCrds?booleanif set, no CRDs will be installed.
timeout?DurationAmount of time to wait for any individual Kubernetes operation.
values?{ [string]: any }The values to be used by the chart.
version?stringThe chart version to install.
wait?booleanWhether 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.

chart?

Type: string (optional, default: No chart name. Implies chartAsset is used.)

The name of the chart.

Either this or chartAsset must be specified.


chartAsset?

Type: Asset (optional, default: No chart asset. Implies chart is used.)

The chart in the form of an asset.

Either this or chart must be specified.


createNamespace?

Type: boolean (optional, default: true)

create namespace if not exist.


namespace?

Type: string (optional, default: default)

The Kubernetes namespace scope of the requests.


release?

Type: string (optional, default: If no release name is given, it will use the last 53 characters of the node's unique id.)

The name of the release.


repository?

Type: string (optional, default: No repository will be used, which means that the chart needs to be an absolute URL.)

The repository which contains the chart.

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


skipCrds?

Type: boolean (optional, default: CRDs are installed if not already present)

if set, no CRDs will be installed.


timeout?

Type: Duration (optional, default: Duration.minutes(5))

Amount of time to wait for any individual Kubernetes operation.

Maximum 15 minutes.


values?

Type: { [string]: any } (optional, default: No values are provided to the chart.)

The values to be used by the chart.

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


version?

Type: string (optional, default: If this is not specified, the latest version is installed)

The chart version to install.


wait?

Type: boolean (optional, default: Helm will not wait before marking release as successful)

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.