Class HelmChartProps

(experimental) Helm Chart properties.

Inheritance
object
HelmChartProps
Inherited Members
Namespace: Amazon.CDK.AWS.Eks.V2.Alpha
Assembly: Amazon.CDK.AWS.Eks.V2.Alpha.dll
Syntax (csharp)
public class HelmChartProps : IHelmChartProps, IHelmChartOptions
Syntax (vb)
Public Class HelmChartProps Implements IHelmChartProps, IHelmChartOptions
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Cluster cluster;

             // option 1: use a construct
             // option 1: use a construct
             new HelmChart(this, "MyOCIChart", new HelmChartProps {
                 Cluster = cluster,
                 Chart = "some-chart",
                 Repository = "oci://${ACCOUNT_ID}.dkr.ecr.${ACCOUNT_REGION}.amazonaws.com/${REPO_NAME}",
                 Namespace = "oci",
                 Version = "0.0.1"
             });

Synopsis

Constructors

HelmChartProps()

(experimental) Helm Chart properties.

Properties

Atomic

(experimental) Whether or not Helm should treat this operation as atomic;
Chart

(experimental) The name of the chart.
ChartAsset

(experimental) The chart in the form of an asset.
Cluster

(experimental) The EKS cluster to apply this configuration to.
CreateNamespace

(experimental) create namespace if not exist.
Namespace

(experimental) The Kubernetes namespace scope of the requests.
Release

(experimental) The name of the release.
Repository

(experimental) The repository which contains the chart.
SkipCrds

(experimental) if set, no CRDs will be installed.
Timeout

(experimental) Amount of time to wait for any individual Kubernetes operation.
Values

(experimental) The values to be used by the chart.
Version

(experimental) The chart version to install.
Wait

(experimental) 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.

Constructors

HelmChartProps()

(experimental) Helm Chart properties.

public HelmChartProps()
Remarks

Stability: Experimental

ExampleMetadata: infused

Examples
Cluster cluster;

             // option 1: use a construct
             // option 1: use a construct
             new HelmChart(this, "MyOCIChart", new HelmChartProps {
                 Cluster = cluster,
                 Chart = "some-chart",
                 Repository = "oci://${ACCOUNT_ID}.dkr.ecr.${ACCOUNT_REGION}.amazonaws.com/${REPO_NAME}",
                 Namespace = "oci",
                 Version = "0.0.1"
             });

Properties

Atomic

(experimental) Whether or not Helm should treat this operation as atomic;

public bool? Atomic { get; set; }
Property Value

bool?

Remarks

if set, upgrade process rolls back changes made in case of failed upgrade. The --wait flag will be set automatically if --atomic is used.

Default: false

Stability: Experimental

Chart

(experimental) The name of the chart.

public string? Chart { get; set; }
Property Value

string

Remarks

Either this or chartAsset must be specified.

Default: - No chart name. Implies chartAsset is used.

Stability: Experimental

ChartAsset

(experimental) The chart in the form of an asset.

public Asset? ChartAsset { get; set; }
Property Value

Asset

Remarks

Either this or chart must be specified.

Default: - No chart asset. Implies chart is used.

Stability: Experimental

Cluster

(experimental) The EKS cluster to apply this configuration to.

public ICluster Cluster { get; set; }
Property Value

ICluster

Remarks

[disable-awslint:ref-via-interface]

Stability: Experimental

CreateNamespace

(experimental) create namespace if not exist.

public bool? CreateNamespace { get; set; }
Property Value

bool?

Remarks

Default: true

Stability: Experimental

Namespace

(experimental) The Kubernetes namespace scope of the requests.

public string? Namespace { get; set; }
Property Value

string

Remarks

Default: default

Stability: Experimental

Release

(experimental) The name of the release.

public string? Release { get; set; }
Property Value

string

Remarks

Default: - If no release name is given, it will use the last 53 characters of the node's unique id.

Stability: Experimental

Repository

(experimental) The repository which contains the chart.

public string? Repository { get; set; }
Property Value

string

Remarks

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

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

Stability: Experimental

SkipCrds

(experimental) if set, no CRDs will be installed.

public bool? SkipCrds { get; set; }
Property Value

bool?

Remarks

Default: - CRDs are installed if not already present

Stability: Experimental

Timeout

(experimental) Amount of time to wait for any individual Kubernetes operation.

public Duration? Timeout { get; set; }
Property Value

Duration

Remarks

Maximum 15 minutes.

Default: Duration.minutes(5)

Stability: Experimental

Values

(experimental) The values to be used by the chart.

public IDictionary<string, object>? Values { get; set; }
Property Value

IDictionary<string, object>

Remarks

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

Default: - No values are provided to the chart.

Stability: Experimental

Version

(experimental) The chart version to install.

public string? Version { get; set; }
Property Value

string

Remarks

Default: - If this is not specified, the latest version is installed

Stability: Experimental

Wait

(experimental) 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.

public bool? Wait { get; set; }
Property Value

bool?

Remarks

Default: - Helm will not wait before marking release as successful

Stability: Experimental

Implements