class HelmChart (construct) ⚠️

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

⚠️ Deprecated: undefined

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 `addChart`
cluster.addChart('NginxIngress', {
  chart: 'nginx-ingress',
  repository: 'https://helm.nginx.com/stable',
  namespace: 'kube-system',
});

Initializer

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

⚠️ Deprecated: undefined

Parameters

• scope Construct
• id string
• props HelmChartProps

Construct Props

Name	Type	Description
chart⚠️	string	The name of the chart.
cluster⚠️	Cluster	The EKS cluster to apply this configuration to.
namespace?⚠️	string	The Kubernetes namespace scope of the requests.
release?⚠️	string	The name of the release.
repository?⚠️	string	The repository which contains the chart.
values?⚠️	{ [string]: any }	The values to be used by the chart.
version?⚠️	string	The chart version to install.

---

chart⚠️

⚠️ Deprecated: undefined

Type: string

The name of the chart.

---

cluster⚠️

⚠️ Deprecated: undefined

Type: Cluster

The EKS cluster to apply this configuration to.

[disable-awslint:ref-via-interface]

---

namespace?⚠️

⚠️ Deprecated: undefined

Type: string (optional, default: default)

The Kubernetes namespace scope of the requests.

---

release?⚠️

⚠️ Deprecated: undefined

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

The name of the release.

---

repository?⚠️

⚠️ Deprecated: undefined

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/

---

values?⚠️

⚠️ Deprecated: undefined

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

The values to be used by the chart.

---

version?⚠️

⚠️ Deprecated: undefined

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

The chart version to install.

Properties

Name	Type	Description
node⚠️	ConstructNode	The construct tree node associated with this construct.
static RESOURCE_TYPE⚠️	string	The CloudFormation reosurce type.

---

node⚠️

⚠️ Deprecated: undefined

Type: ConstructNode

The construct tree node associated with this construct.

---

static RESOURCE_TYPE⚠️

⚠️ Deprecated: undefined

Type: string

The CloudFormation reosurce type.

Methods

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

---

toString()⚠️

public toString(): string

⚠️ Deprecated: undefined

Returns

• string

Returns a string representation of this construct.