Package org.cdk8s.plus23

Interface PersistentVolumeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceProps

All Known Subinterfaces:

AwsElasticBlockStorePersistentVolumeProps, AzureDiskPersistentVolumeProps, GCEPersistentDiskPersistentVolumeProps

All Known Implementing Classes:

AwsElasticBlockStorePersistentVolumeProps.Jsii$Proxy, AzureDiskPersistentVolumeProps.Jsii$Proxy, GCEPersistentDiskPersistentVolumeProps.Jsii$Proxy, PersistentVolumeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.61.0 (build abf4039)",
           date="2022-07-06T20:17:23.645Z")
@Stability(Stable)
public interface PersistentVolumeProps
extends software.amazon.jsii.JsiiSerializable, ResourceProps

Properties for `PersistentVolume`.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PersistentVolumeProps.Builder	builder()
default List<PersistentVolumeAccessMode>	getAccessModes()	Contains all ways the volume can be mounted.
default IPersistentVolumeClaim	getClaim()	Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
default List<String>	getMountOptions()	A list of mount options, e.g.
default PersistentVolumeReclaimPolicy	getReclaimPolicy()	When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.
default org.cdk8s.Size	getStorage()	What is the storage capacity of this volume.
default String	getStorageClassName()	Name of StorageClass to which this persistent volume belongs.
default PersistentVolumeMode	getVolumeMode()	Defines what type of volume is required by the claim.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface org.cdk8s.plus23.ResourceProps

getMetadata

Method Detail

getAccessModes

@Stability(Stable)
@Nullable
default List<PersistentVolumeAccessMode> getAccessModes()

Contains all ways the volume can be mounted.

Default: - No access modes.

See Also:

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

getClaim

@Stability(Stable)
@Nullable
default IPersistentVolumeClaim getClaim()

Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

Expected to be non-nil when bound.

Default: - Not bound to a specific claim.

See Also:

https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding

getMountOptions

@Stability(Stable)
@Nullable
default List<String> getMountOptions()

A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid.

Default: - No options.

See Also:

https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options

getReclaimPolicy

@Stability(Stable)
@Nullable
default PersistentVolumeReclaimPolicy getReclaimPolicy()

When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.

The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.

Default: PersistentVolumeReclaimPolicy.RETAIN

See Also:

https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming

getStorage

@Stability(Stable)
@Nullable
default org.cdk8s.Size getStorage()

What is the storage capacity of this volume.

Default: - No specified.

See Also:

https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

getStorageClassName

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

Name of StorageClass to which this persistent volume belongs.

Default: - Volume does not belong to any storage class.

getVolumeMode

@Stability(Stable)
@Nullable
default PersistentVolumeMode getVolumeMode()

Defines what type of volume is required by the claim.

Default: VolumeMode.FILE_SYSTEM

builder

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

Returns:

a PersistentVolumeProps.Builder of PersistentVolumeProps