HelmChartProps

class aws_cdk.aws_eks.HelmChartProps(*, chart=None, chart_asset=None, create_namespace=None, namespace=None, release=None, repository=None, timeout=None, values=None, version=None, wait=None, cluster)

Bases: HelmChartOptions

Helm Chart properties.

Parameters
  • chart (Optional[str]) – The name of the chart. Either this or chartAsset must be specified. Default: - No chart name. Implies chartAsset is used.

  • chart_asset (Optional[Asset]) – The chart in the form of an asset. Either this or chart must be specified. Default: - No chart asset. Implies chart is used.

  • create_namespace (Optional[bool]) – create namespace if not exist. Default: true

  • namespace (Optional[str]) – The Kubernetes namespace scope of the requests. Default: default

  • release (Optional[str]) – 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.

  • repository (Optional[str]) – The repository which contains the chart. For example: https://kubernetes-charts.storage.googleapis.com/ Default: - No repository will be used, which means that the chart needs to be an absolute URL.

  • timeout (Optional[Duration]) – Amount of time to wait for any individual Kubernetes operation. Maximum 15 minutes. Default: Duration.minutes(5)

  • values (Optional[Mapping[str, Any]]) – The values to be used by the chart. Default: - No values are provided to the chart.

  • version (Optional[str]) – The chart version to install. Default: - If this is not specified, the latest version is installed

  • wait (Optional[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

  • cluster (ICluster) – The EKS cluster to apply this configuration to. [disable-awslint:ref-via-interface]

ExampleMetadata

infused

Example:

# cluster: eks.Cluster

# option 1: use a construct
eks.HelmChart(self, "NginxIngress",
    cluster=cluster,
    chart="nginx-ingress",
    repository="https://helm.nginx.com/stable",
    namespace="kube-system"
)

# or, option2: use `addHelmChart`
cluster.add_helm_chart("NginxIngress",
    chart="nginx-ingress",
    repository="https://helm.nginx.com/stable",
    namespace="kube-system"
)

Attributes

chart

The name of the chart.

Either this or chartAsset must be specified.

Default
  • No chart name. Implies chartAsset is used.

chart_asset

The chart in the form of an asset.

Either this or chart must be specified.

Default
  • No chart asset. Implies chart is used.

cluster

The EKS cluster to apply this configuration to.

[disable-awslint:ref-via-interface]

create_namespace

create namespace if not exist.

Default

true

namespace

The Kubernetes namespace scope of the requests.

Default

default

release

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.

repository

The repository which contains the chart.

For example: https://kubernetes-charts.storage.googleapis.com/

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

timeout

Amount of time to wait for any individual Kubernetes operation.

Maximum 15 minutes.

Default

Duration.minutes(5)

values

The values to be used by the chart.

Default
  • No values are provided to the chart.

version

The chart version to install.

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

wait

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