Class HelmChartProps
Helm Chart properties.
Inheritance
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.AWS.EKS.dll
Syntax (csharp)
public class HelmChartProps : Object, IHelmChartProps, IHelmChartOptions
Syntax (vb)
Public Class HelmChartProps
Inherits Object
Implements IHelmChartProps, IHelmChartOptions
Remarks
ExampleMetadata: infused
Examples
Cluster cluster;
// option 1: use a construct
// option 1: use a construct
new HelmChart(this, "NginxIngress", new HelmChartProps {
Cluster = cluster,
Chart = "nginx-ingress",
Repository = "https://helm.nginx.com/stable",
Namespace = "kube-system"
});
// or, option2: use `addHelmChart`
cluster.AddHelmChart("NginxIngress", new HelmChartOptions {
Chart = "nginx-ingress",
Repository = "https://helm.nginx.com/stable",
Namespace = "kube-system"
});
Synopsis
Constructors
HelmChartProps() |
Properties
Chart | The name of the chart. |
ChartAsset | The chart in the form of an asset. |
Cluster | The EKS cluster to apply this configuration to. |
CreateNamespace | create namespace if not exist. |
Namespace | The Kubernetes namespace scope of the requests. |
Release | The name of the release. |
Repository | The repository which contains the chart. |
Timeout | Amount of time to wait for any individual Kubernetes operation. |
Values | The values to be used by the chart. |
Version | The chart version to install. |
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. |
Constructors
HelmChartProps()
public HelmChartProps()
Properties
Chart
The name of the chart.
public string Chart { get; set; }
Property Value
System.String
Remarks
Either this or chartAsset
must be specified.
Default: - No chart name. Implies chartAsset
is used.
ChartAsset
The chart in the form of an asset.
public Asset ChartAsset { get; set; }
Property Value
Remarks
Either this or chart
must be specified.
Default: - No chart asset. Implies chart
is used.
Cluster
The EKS cluster to apply this configuration to.
public ICluster Cluster { get; set; }
Property Value
Remarks
[disable-awslint:ref-via-interface]
CreateNamespace
create namespace if not exist.
public Nullable<bool> CreateNamespace { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
Namespace
The Kubernetes namespace scope of the requests.
public string Namespace { get; set; }
Property Value
System.String
Remarks
Default: default
Release
The name of the release.
public string Release { get; set; }
Property Value
System.String
Remarks
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.
public string Repository { get; set; }
Property Value
System.String
Remarks
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.
public Duration Timeout { get; set; }
Property Value
Remarks
Maximum 15 minutes.
Default: Duration.minutes(5)
Values
The values to be used by the chart.
public IDictionary<string, object> Values { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: - No values are provided to the chart.
Version
The chart version to install.
public string Version { get; set; }
Property Value
System.String
Remarks
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.
public Nullable<bool> Wait { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: - Helm will not wait before marking release as successful