Package org.cdk8s.plus24

Interface PersistentVolumeClaimProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ResourceProps

All Known Implementing Classes:

PersistentVolumeClaimProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-07-02T00:26:57.599Z")
@Stability(Stable)
public interface PersistentVolumeClaimProps
extends software.amazon.jsii.JsiiSerializable, ResourceProps

Properties for PersistentVolumeClaim.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PersistentVolumeClaimProps.Builder	builder()
default List<PersistentVolumeAccessMode>	getAccessModes()	Contains the access modes the volume should support.
default org.cdk8s.Size	getStorage()	Minimum storage size the volume should have.
default String	getStorageClassName()	Name of the StorageClass required by the claim.
default IPersistentVolume	getVolume()	The PersistentVolume backing this claim.
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.plus24.ResourceProps

getMetadata

Method Detail

getAccessModes

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

Contains the access modes the volume should support.

Default: - No access modes requirement.

See Also:

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

getStorage

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

Minimum storage size the volume should have.

Default: - No storage requirement.

See Also:

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

getStorageClassName

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

Name of the StorageClass required by the claim. When this property is not set, the behavior is as follows:.

• If the admission plugin is turned on, the storage class marked as default will be used.
• If the admission plugin is turned off, the pvc can only be bound to volumes without a storage class.

Default: - Not set.

See Also:

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

getVolume

@Stability(Stable)
@Nullable
default IPersistentVolume getVolume()

The PersistentVolume backing this claim.

The control plane still checks that storage class, access modes, and requested storage size on the volume are valid.

Note that in order to guarantee a proper binding, the volume should also define a claimRef referring to this claim. Otherwise, the volume may be claimed be other pvc's before it gets a chance to bind to this one.

If the volume is managed (i.e not imported), you can use pv.claim() to easily create a bi-directional bounded claim.

Default: - No specific volume binding.

See Also:

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

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 PersistentVolumeClaimProps.Builder builder()

Returns:

a PersistentVolumeClaimProps.Builder of PersistentVolumeClaimProps