class HelmChart (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.EKS.HelmChart`
Java	`software.amazon.awscdk.services.eks.HelmChart`
Python	`aws_cdk.aws_eks.HelmChart`
TypeScript (source)	`@aws-cdk/aws-eks` » `HelmChart`

Implements IConstruct, IConstruct, IDependable

Represents a helm chart within the Kubernetes system.

Applies/deletes the resources using kubectl in sync with the resource.

Example

declare const cluster: eks.Cluster;
// option 1: use a construct
new eks.HelmChart(this, 'NginxIngress', {
  cluster,
  chart: 'nginx-ingress',
  repository: 'https://helm.nginx.com/stable',
  namespace: 'kube-system',
});

// or, option2: use `addHelmChart`
cluster.addHelmChart('NginxIngress', {
  chart: 'nginx-ingress',
  repository: 'https://helm.nginx.com/stable',
  namespace: 'kube-system',
});

Initializer

new HelmChart(scope: Construct, id: string, props: HelmChartProps)

Parameters

scope Construct
id string
props HelmChartProps

Construct Props

Name	Type	Description
cluster	`ICluster`	The EKS cluster to apply this configuration to.
chart?	`string`	The name of the chart.
chartAsset?	`Asset`	The chart in the form of an asset.
createNamespace?	`boolean`	create namespace if not exist.
namespace?	`string`	The Kubernetes namespace scope of the requests.
release?	`string`	The name of the release.
repository?	`string`	The repository which contains the chart.
timeout?	`Duration`	Amount of time to wait for any individual Kubernetes operation.
values?	`{ [string]: any }`	The values to be used by the chart.
version?	`string`	The chart version to install.
wait?	`boolean`	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.

cluster

Type: ICluster

The EKS cluster to apply this configuration to.

[disable-awslint:ref-via-interface]

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://kubernetes-charts.storage.googleapis.com/

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.

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.

Properties

Name	Type	Description
node	`ConstructNode`	The construct tree node associated with this construct.
static RESOURCE_TYPE	`string`	The CloudFormation resource type.

node

Type: ConstructNode

The construct tree node associated with this construct.

static RESOURCE_TYPE

Type: string

The CloudFormation resource type.

Methods

Name	Description
toString()	Returns a string representation of this construct.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.