Package org.cdk8s.plus25.k8s

Interface PersistentVolumeSpec

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    PersistentVolumeSpec.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.763Z")
@Stability(Stable)
public interface PersistentVolumeSpec
extends software.amazon.jsii.JsiiSerializable
    PersistentVolumeSpec is the specification of a persistent volume.

    • Method Detail

      • getAccessModes

        @Stability(Stable)
@Nullable
default List<String> getAccessModes()
        accessModes contains all ways the volume can be mounted.

        More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

      • getAwsElasticBlockStore

        @Stability(Stable)
@Nullable
default AwsElasticBlockStoreVolumeSource getAwsElasticBlockStore()
        awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod.

        More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

      • getAzureDisk

        @Stability(Stable)
@Nullable
default AzureDiskVolumeSource getAzureDisk()
        azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

      • getAzureFile

        @Stability(Stable)
@Nullable
default AzureFilePersistentVolumeSource getAzureFile()
        azureFile represents an Azure File Service mount on the host and bind mount to the pod.

      • getCapacity

        @Stability(Stable)
@Nullable
default Map<String,​Quantity> getCapacity()
        capacity is the description of the persistent volume's resources and capacity.

        More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

      • getCephfs

        @Stability(Stable)
@Nullable
default CephFsPersistentVolumeSource getCephfs()
        cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.

      • getCinder

        @Stability(Stable)
@Nullable
default CinderPersistentVolumeSource getCinder()
        cinder represents a cinder volume attached and mounted on kubelets host machine.

        More info: https://examples.k8s.io/mysql-cinder-pd/README.md

      • getClaimRef

        @Stability(Stable)
@Nullable
default ObjectReference getClaimRef()
        claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

        Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

      • getCsi

        @Stability(Stable)
@Nullable
default CsiPersistentVolumeSource getCsi()
        csi represents storage that is handled by an external CSI driver (Beta feature).

      • getFc

        @Stability(Stable)
@Nullable
default FcVolumeSource getFc()
        fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

      • getFlexVolume

        @Stability(Stable)
@Nullable
default FlexPersistentVolumeSource getFlexVolume()
        flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

      • getFlocker

        @Stability(Stable)
@Nullable
default FlockerVolumeSource getFlocker()
        flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage.

        This depends on the Flocker control service being running

      • getGcePersistentDisk

        @Stability(Stable)
@Nullable
default GcePersistentDiskVolumeSource getGcePersistentDisk()
        gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod.

        Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

      • getGlusterfs

        @Stability(Stable)
@Nullable
default GlusterfsPersistentVolumeSource getGlusterfs()
        glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod.

        Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md

      • getHostPath

        @Stability(Stable)
@Nullable
default HostPathVolumeSource getHostPath()
        hostPath represents a directory on the host.

        Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

      • getIscsi

        @Stability(Stable)
@Nullable
default IscsiPersistentVolumeSource getIscsi()
        iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod.

        Provisioned by an admin.

      • getLocal

        @Stability(Stable)
@Nullable
default LocalVolumeSource getLocal()
        local represents directly-attached storage with node affinity.

      • getMountOptions

        @Stability(Stable)
@Nullable
default List<String> getMountOptions()
        mountOptions is the list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options.

      • getNfs

        @Stability(Stable)
@Nullable
default NfsVolumeSource getNfs()
        nfs represents an NFS mount on the host.

        Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

      • getNodeAffinity

        @Stability(Stable)
@Nullable
default VolumeNodeAffinity getNodeAffinity()
        nodeAffinity defines constraints that limit what nodes this volume can be accessed from.

        This field influences the scheduling of pods that use this volume.

      • getPersistentVolumeReclaimPolicy

        @Stability(Stable)
@Nullable
default String getPersistentVolumeReclaimPolicy()
        persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim.

        Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

      • getPhotonPersistentDisk

        @Stability(Stable)
@Nullable
default PhotonPersistentDiskVolumeSource getPhotonPersistentDisk()
        photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.

      • getPortworxVolume

        @Stability(Stable)
@Nullable
default PortworxVolumeSource getPortworxVolume()
        portworxVolume represents a portworx volume attached and mounted on kubelets host machine.

      • getQuobyte

        @Stability(Stable)
@Nullable
default QuobyteVolumeSource getQuobyte()
        quobyte represents a Quobyte mount on the host that shares a pod's lifetime.

      • getRbd

        @Stability(Stable)
@Nullable
default RbdPersistentVolumeSource getRbd()
        rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.

        More info: https://examples.k8s.io/volumes/rbd/README.md

      • getScaleIo

        @Stability(Stable)
@Nullable
default ScaleIoPersistentVolumeSource getScaleIo()
        scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

      • getStorageClassName

        @Stability(Stable)
@Nullable
default String getStorageClassName()
        storageClassName is the name of StorageClass to which this persistent volume belongs.

        Empty value means that this volume does not belong to any StorageClass.

      • getStorageos

        @Stability(Stable)
@Nullable
default StorageOsPersistentVolumeSource getStorageos()
        storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md.

      • getVolumeMode

        @Stability(Stable)
@Nullable
default String getVolumeMode()
        volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state.

        Value of Filesystem is implied when not included in spec.

      • getVsphereVolume

        @Stability(Stable)
@Nullable
default VsphereVirtualDiskVolumeSource getVsphereVolume()
        vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.