Package org.cdk8s.plus24.k8s

Interface VolumeMount

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

VolumeMount.Jsii$Proxy

@Generated(value="jsii-pacmak/1.85.0 (build 08ee592)",
           date="2023-07-25T00:18:39.529Z")
@Stability(Stable)
public interface VolumeMount
extends software.amazon.jsii.JsiiSerializable

VolumeMount describes a mounting of a Volume within a container.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static VolumeMount.Builder	builder()
String	getMountPath()	Path within the container at which the volume should be mounted.
default String	getMountPropagation()	mountPropagation determines how mounts are propagated from the host to container and the other way around.
String	getName()	This must match the Name of a Volume.
default Boolean	getReadOnly()	Mounted read-only if true, read-write otherwise (false or unspecified).
default String	getSubPath()	Path within the volume from which the container's volume should be mounted.
default String	getSubPathExpr()	Expanded path within the volume from which the container's volume should be mounted.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMountPath

@Stability(Stable)
@NotNull
String getMountPath()

Path within the container at which the volume should be mounted.

Must not contain ':'.

getName

@Stability(Stable)
@NotNull
String getName()

This must match the Name of a Volume.

getMountPropagation

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

mountPropagation determines how mounts are propagated from the host to container and the other way around.

When not set, MountPropagationNone is used. This field is beta in 1.10.

getReadOnly

@Stability(Stable)
@Nullable
default Boolean getReadOnly()

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

Defaults to false.

Default: false.

getSubPath

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

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

Defaults to "" (volume's root).

Default: volume's root).

getSubPathExpr

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

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.

Default: volume's root). SubPathExpr and SubPath are mutually exclusive.

builder

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

Returns:

a VolumeMount.Builder of VolumeMount