HelmChartOptions

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

Bases: object

Helm Chart options.

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

ExampleMetadata

infused

Example:

import aws_cdk.aws_s3_assets as s3_assets

# cluster: eks.Cluster

chart_asset = s3_assets.Asset(self, "ChartAsset",
    path="/path/to/asset"
)

cluster.add_helm_chart("test-chart",
    chart_asset=chart_asset
)

Attributes

chart

The name of the chart.

Either this or chartAsset must be specified.

Default
  • No chart name. Implies chartAsset is used.

Return type

Optional[str]

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.

Return type

Optional[Asset]

create_namespace

create namespace if not exist.

Default

true

Return type

Optional[bool]

namespace

The Kubernetes namespace scope of the requests.

Default

default

Return type

Optional[str]

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.

Return type

Optional[str]

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.

Return type

Optional[str]

timeout

Amount of time to wait for any individual Kubernetes operation.

Maximum 15 minutes.

Default

Duration.minutes(5)

Return type

Optional[Duration]

values

The values to be used by the chart.

Default
  • No values are provided to the chart.

Return type

Optional[Mapping[str, Any]]

version

The chart version to install.

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

Return type

Optional[str]

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

Return type

Optional[bool]