Package org.cdk8s.plus24

Class VolumeMount.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<VolumeMount>
    Enclosing interface:
    VolumeMount
    @Stability(Stable)
public static final class VolumeMount.Builder
extends Object
implements software.amazon.jsii.Builder<VolumeMount>
    A builder for VolumeMount

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • path

        @Stability(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

      • propagation

        @Stability(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.

        Returns:
        this

      • readOnly

        @Stability(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

      • subPathExpr

        @Stability(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.

        Returns:
        this

      • build

        @Stability(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