Package org.cdk8s

Interface HelmProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HelmProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T12:14:30.772Z")
@Stability(Stable)
public interface HelmProps
extends software.amazon.jsii.JsiiSerializable

Options for Helm.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	HelmProps.Builder	A builder for HelmProps
static class	HelmProps.Jsii$Proxy	An implementation for HelmProps

Method Summary

Modifier and Type	Method	Description
static HelmProps.Builder	builder()
String	getChart()	The chart name to use.
default String	getHelmExecutable()	The local helm executable to use in order to create the manifest the chart.
default List<String>	getHelmFlags()	Additional flags to add to the helm execution.
default String	getNamespace()	Scope all resources in to a given namespace.
default String	getReleaseName()	The release name.
default String	getRepo()	Chart repository url where to locate the requested chart.
default Map<String,Object>	getValues()	Values to pass to the chart.
default String	getVersion()	Version constraint for the chart version to use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getChart

@Stability(Stable)
@NotNull
String getChart()

The chart name to use. It can be a chart from a helm repository or a local directory.

This name is passed to helm template and has all the relevant semantics.

Example:

 "bitnami/redis"
 

getHelmExecutable

@Stability(Stable)
@Nullable
default String getHelmExecutable()

The local helm executable to use in order to create the manifest the chart.

Default: "helm"

getHelmFlags

@Stability(Stable)
@Nullable
default List<String> getHelmFlags()

Additional flags to add to the helm execution.

Default: []

getNamespace

@Stability(Stable)
@Nullable
default String getNamespace()

Scope all resources in to a given namespace.

getReleaseName

@Stability(Stable)
@Nullable
default String getReleaseName()

The release name.

Default: - if unspecified, a name will be allocated based on the construct path

See Also:

https://helm.sh/docs/intro/using_helm/#three-big-concepts

getRepo

@Stability(Stable)
@Nullable
default String getRepo()

Chart repository url where to locate the requested chart.

getValues

@Stability(Stable)
@Nullable
default Map<String,Object> getValues()

Values to pass to the chart.

Default: - If no values are specified, chart will use the defaults.

getVersion

@Stability(Stable)
@Nullable
default String getVersion()

Version constraint for the chart version to use.

This constraint can be a specific tag (e.g. 1.1.1) or it may reference a valid range (e.g. ^2.0.0). If this is not specified, the latest version is used

This name is passed to helm template --version and has all the relevant semantics.

Example:

 "^2.0.0"
 

builder

@Stability(Stable)
static HelmProps.Builder builder()

Returns:

a HelmProps.Builder of HelmProps