org.cdk8s.plus20

Class VolumeMount.Builder

java.lang.Object

org.cdk8s.plus20.VolumeMount.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<VolumeMount>

Enclosing interface:

VolumeMount

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

A builder for VolumeMount

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
VolumeMount	build() Builds the configured instance.
VolumeMount.Builder	path(String path) Sets the value of VolumeMount.getPath()
VolumeMount.Builder	propagation(MountPropagation propagation) Sets the value of MountOptions.getPropagation()
VolumeMount.Builder	readOnly(Boolean readOnly) Sets the value of MountOptions.getReadOnly()
VolumeMount.Builder	subPath(String subPath) Sets the value of MountOptions.getSubPath()
VolumeMount.Builder	subPathExpr(String subPathExpr) Sets the value of MountOptions.getSubPathExpr()
VolumeMount.Builder	volume(Volume volume) Sets the value of VolumeMount.getVolume()

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

path

@Stability(value=Stable)
public VolumeMount.Builder path(String path)

Sets the value of VolumeMount.getPath()

Parameters:

path - Path within the container at which the volume should be mounted. This parameter is required. Must not contain ':'.

Returns:

this

volume

@Stability(value=Stable)
public VolumeMount.Builder volume(Volume volume)

Sets the value of VolumeMount.getVolume()

Parameters:

volume - The volume to mount. This parameter is required.

Returns:

this

propagation

@Stability(value=Stable)
public VolumeMount.Builder propagation(MountPropagation propagation)

Sets the value of MountOptions.getPropagation()

Parameters:

propagation - Determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used.

Mount propagation allows for sharing volumes mounted by a Container to other Containers in the same Pod, or even to other Pods on the same node.

This field is beta in 1.10.

Returns:

this

readOnly

@Stability(value=Stable)
public VolumeMount.Builder readOnly(Boolean readOnly)

Sets the value of MountOptions.getReadOnly()

Parameters:

readOnly - Mounted read-only if true, read-write otherwise (false or unspecified). Defaults to false.

Returns:

this

subPath

@Stability(value=Stable)
public VolumeMount.Builder subPath(String subPath)

Sets the value of MountOptions.getSubPath()

Parameters:

subPath - Path within the volume from which the container's volume should be mounted.).

Returns:

this

subPathExpr

@Stability(value=Stable)
public VolumeMount.Builder subPathExpr(String subPathExpr)

Sets the value of MountOptions.getSubPathExpr()

Parameters:

subPathExpr - Expanded path within the volume from which the container's volume should be mounted. Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. Defaults to "" (volume's root). SubPathExpr and SubPath are mutually exclusive. This field is beta in 1.15.

subPathExpr and subPath are mutually exclusive. This field is beta in 1.15.

Returns:

this

build

@Stability(value=Stable)
public VolumeMount build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of VolumeMount

Throws:

NullPointerException - if any required attribute was not provided