Package org.cdk8s.plus24.k8s

Interface CsiVolumeSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CsiVolumeSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.85.0 (build 08ee592)",
           date="2023-07-25T00:18:39.185Z")
@Stability(Stable)
public interface CsiVolumeSource
extends software.amazon.jsii.JsiiSerializable

Represents a source location of a volume to mount, managed by an external CSI driver.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CsiVolumeSource.Builder	builder()
String	getDriver()	driver is the name of the CSI driver that handles this volume.
default String	getFsType()	fsType to mount.
default LocalObjectReference	getNodePublishSecretRef()	nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls.
default Boolean	getReadOnly()	readOnly specifies a read-only configuration for the volume.
default Map<String,String>	getVolumeAttributes()	volumeAttributes stores driver-specific properties that are passed to the CSI driver.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDriver

@Stability(Stable)
@NotNull
String getDriver()

driver is the name of the CSI driver that handles this volume.

Consult with your admin for the correct name as registered in the cluster.

getFsType

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

fsType to mount.

Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

getNodePublishSecretRef

@Stability(Stable)
@Nullable
default LocalObjectReference getNodePublishSecretRef()

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls.

This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

getReadOnly

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

readOnly specifies a read-only configuration for the volume.

Defaults to false (read/write).

Default: false (read/write).

getVolumeAttributes

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

volumeAttributes stores driver-specific properties that are passed to the CSI driver.

Consult your driver's documentation for supported values.

builder

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

Returns:

a CsiVolumeSource.Builder of CsiVolumeSource