Package org.cdk8s.plus23

Interface MountOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

VolumeMount

All Known Implementing Classes:

MountOptions.Jsii$Proxy, VolumeMount.Jsii$Proxy

@Generated(value="jsii-pacmak/1.69.0 (build f656c31)",
           date="2022-10-15T03:08:35.108Z")
@Stability(Stable)
public interface MountOptions
extends software.amazon.jsii.JsiiSerializable

Options for mounts.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MountOptions.Builder	builder()
default MountPropagation	getPropagation()	Determines how mounts are propagated from the host to container and the other way around.
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

getPropagation

@Stability(Stable)
@Nullable
default MountPropagation getPropagation()

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.

Default: MountPropagation.NONE

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.).

Default: "" the 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.

builder

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

Returns:

a MountOptions.Builder of MountOptions