Package org.cdk8s

Class Helm.Builder

java.lang.Object

org.cdk8s.Helm.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Helm>

Enclosing class:

Helm

@Stability(Stable)
public static final class Helm.Builder
extends Object
implements software.amazon.jsii.Builder<Helm>

A fluent builder for Helm.

Method Summary

Modifier and Type	Method	Description
Helm	build()
Helm.Builder	chart(String chart)	The chart name to use.
static Helm.Builder	create(software.constructs.Construct scope, String id)
Helm.Builder	helmExecutable(String helmExecutable)	The local helm executable to use in order to create the manifest the chart.
Helm.Builder	helmFlags(List<String> helmFlags)	Additional flags to add to the `helm` execution.
Helm.Builder	namespace(String namespace)	Scope all resources in to a given namespace.
Helm.Builder	releaseName(String releaseName)	The release name.
Helm.Builder	repo(String repo)	Chart repository url where to locate the requested chart.
Helm.Builder	values(Map<String,? extends Object> values)	Values to pass to the chart.
Helm.Builder	version(String version)	Version constraint for the chart version to use.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Stable)
public static Helm.Builder create(software.constructs.Construct scope,
                                  String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of Helm.Builder.

chart

@Stability(Stable)
public Helm.Builder chart(String chart)

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"
 

Parameters:

chart - The chart name to use. It can be a chart from a helm repository or a local directory. This parameter is required.

Returns:

this

helmExecutable

@Stability(Stable)
public Helm.Builder helmExecutable(String helmExecutable)

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

Default: "helm"

Parameters:

helmExecutable - The local helm executable to use in order to create the manifest the chart. This parameter is required.

Returns:

this

helmFlags

@Stability(Stable)
public Helm.Builder helmFlags(List<String> helmFlags)

Additional flags to add to the `helm` execution.

Default: []

Parameters:

helmFlags - Additional flags to add to the `helm` execution. This parameter is required.

Returns:

this

namespace

@Stability(Stable)
public Helm.Builder namespace(String namespace)

Scope all resources in to a given namespace.

Parameters:

namespace - Scope all resources in to a given namespace. This parameter is required.

Returns:

this

releaseName

@Stability(Stable)
public Helm.Builder releaseName(String releaseName)

The release name.

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

Parameters:

releaseName - The release name. This parameter is required.

Returns:

this

See Also:

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

repo

@Stability(Stable)
public Helm.Builder repo(String repo)

Chart repository url where to locate the requested chart.

Parameters:

repo - Chart repository url where to locate the requested chart. This parameter is required.

Returns:

this

values

@Stability(Stable)
public Helm.Builder values(Map<String,? extends Object> values)

Values to pass to the chart.

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

Parameters:

values - Values to pass to the chart. This parameter is required.

Returns:

this

version

@Stability(Stable)
public Helm.Builder version(String version)

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"
 

Parameters:

version - Version constraint for the chart version to use. This parameter is required.

Returns:

this

build

@Stability(Stable)
public Helm build()

Specified by:

build in interface software.amazon.jsii.Builder<Helm>