Package org.cdk8s

Class HelmProps.Builder

java.lang.Object

org.cdk8s.HelmProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HelmProps>

Enclosing interface:

HelmProps

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

A builder for HelmProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HelmProps	build()	Builds the configured instance.
HelmProps.Builder	chart(String chart)	Sets the value of HelmProps.getChart()
HelmProps.Builder	helmExecutable(String helmExecutable)	Sets the value of HelmProps.getHelmExecutable()
HelmProps.Builder	helmFlags(List<String> helmFlags)	Sets the value of HelmProps.getHelmFlags()
HelmProps.Builder	namespace(String namespace)	Sets the value of HelmProps.getNamespace()
HelmProps.Builder	releaseName(String releaseName)	Sets the value of HelmProps.getReleaseName()
HelmProps.Builder	repo(String repo)	Sets the value of HelmProps.getRepo()
HelmProps.Builder	values(Map<String,? extends Object> values)	Sets the value of HelmProps.getValues()
HelmProps.Builder	version(String version)	Sets the value of HelmProps.getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

chart

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

Sets the value of HelmProps.getChart()

Parameters:

chart - The chart name to use. It can be a chart from a helm repository or a local directory. This parameter is required. This name is passed to helm template and has all the relevant semantics.

Returns:

this

helmExecutable

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

Sets the value of HelmProps.getHelmExecutable()

Parameters:

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

Returns:

this

helmFlags

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

Sets the value of HelmProps.getHelmFlags()

Parameters:

helmFlags - Additional flags to add to the `helm` execution.

Returns:

this

namespace

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

Sets the value of HelmProps.getNamespace()

Parameters:

namespace - Scope all resources in to a given namespace.

Returns:

this

releaseName

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

Sets the value of HelmProps.getReleaseName()

Parameters:

releaseName - The release name.

Returns:

this

repo

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

Sets the value of HelmProps.getRepo()

Parameters:

repo - Chart repository url where to locate the requested chart.

Returns:

this

values

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

Sets the value of HelmProps.getValues()

Parameters:

values - Values to pass to the chart.

Returns:

this

version

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

Sets the value of HelmProps.getVersion()

Parameters:

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.

Returns:

this

build

@Stability(Stable)
public HelmProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HelmProps

Throws:

NullPointerException - if any required attribute was not provided