Package org.cdk8s.plus28.k8s

Interface KubeStorageClassProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KubeStorageClassProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-03T12:13:25.798Z")
@Stability(Stable)
public interface KubeStorageClassProps
extends software.amazon.jsii.JsiiSerializable

StorageClass describes the parameters for a class of storage for which PersistentVolumes can be dynamically provisioned.

StorageClasses are non-namespaced; the name of the storage class according to etcd is in ObjectMeta.Name.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static KubeStorageClassProps.Builder	builder()
default List<TopologySelectorTerm>	getAllowedTopologies()	allowedTopologies restrict the node topologies where volumes can be dynamically provisioned.
default Boolean	getAllowVolumeExpansion()	allowVolumeExpansion shows whether the storage class allow volume expand.
default ObjectMeta	getMetadata()	Standard object's metadata.
default List<String>	getMountOptions()	mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class.
default Map<String,String>	getParameters()	parameters holds the parameters for the provisioner that should create volumes of this storage class.
String	getProvisioner()	provisioner indicates the type of the provisioner.
default String	getReclaimPolicy()	reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.
default String	getVolumeBindingMode()	volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getProvisioner

@Stability(Stable)
@NotNull
String getProvisioner()

provisioner indicates the type of the provisioner.

getAllowedTopologies

@Stability(Stable)
@Nullable
default List<TopologySelectorTerm> getAllowedTopologies()

allowedTopologies restrict the node topologies where volumes can be dynamically provisioned.

Each volume plugin defines its own supported topology specifications. An empty TopologySelectorTerm list means there is no topology restriction. This field is only honored by servers that enable the VolumeScheduling feature.

getAllowVolumeExpansion

@Stability(Stable)
@Nullable
default Boolean getAllowVolumeExpansion()

allowVolumeExpansion shows whether the storage class allow volume expand.

getMetadata

@Stability(Stable)
@Nullable
default ObjectMeta getMetadata()

Standard object's metadata.

More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

getMountOptions

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

mountOptions controls the mountOptions for dynamically provisioned PersistentVolumes of this storage class.

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

getParameters

@Stability(Stable)
@Nullable
default Map<String,String> getParameters()

parameters holds the parameters for the provisioner that should create volumes of this storage class.

getReclaimPolicy

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

reclaimPolicy controls the reclaimPolicy for dynamically provisioned PersistentVolumes of this storage class.

Defaults to Delete.

Default: Delete.

getVolumeBindingMode

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

volumeBindingMode indicates how PersistentVolumeClaims should be provisioned and bound.

When unset, VolumeBindingImmediate is used. This field is only honored by servers that enable the VolumeScheduling feature.

builder

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

Returns:

a KubeStorageClassProps.Builder of KubeStorageClassProps