Package org.cdk8s.plus25.k8s

Interface CsiPersistentVolumeSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CsiPersistentVolumeSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.88.0 (build eaabd08)",
           date="2023-09-11T06:17:58.490Z")
@Stability(Stable)
public interface CsiPersistentVolumeSource
extends software.amazon.jsii.JsiiSerializable

Represents storage that is managed by an external CSI volume driver (Beta feature).

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CsiPersistentVolumeSource.Builder	builder()
default SecretReference	getControllerExpandSecretRef()	controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call.
default SecretReference	getControllerPublishSecretRef()	controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls.
String	getDriver()	driver is the name of the driver to use for this volume.
default String	getFsType()	fsType to mount.
default SecretReference	getNodeExpandSecretRef()	nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call.
default SecretReference	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 SecretReference	getNodeStageSecretRef()	nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls.
default Boolean	getReadOnly()	readOnly value to pass to ControllerPublishVolumeRequest.
default Map<String,String>	getVolumeAttributes()	volumeAttributes of the volume to publish.
String	getVolumeHandle()	volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getDriver

@Stability(Stable)
@NotNull
String getDriver()

driver is the name of the driver to use for this volume.

Required.

getVolumeHandle

@Stability(Stable)
@NotNull
String getVolumeHandle()

volumeHandle is the unique volume name returned by the CSI volume plugin’s CreateVolume to refer to the volume on all subsequent calls.

Required.

getControllerExpandSecretRef

@Stability(Stable)
@Nullable
default SecretReference getControllerExpandSecretRef()

controllerExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerExpandVolume call.

This is an beta field and requires enabling ExpandCSIVolumes feature gate. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secrets are passed.

getControllerPublishSecretRef

@Stability(Stable)
@Nullable
default SecretReference getControllerPublishSecretRef()

controllerPublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI ControllerPublishVolume and ControllerUnpublishVolume calls.

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

getFsType

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

fsType to mount.

Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs".

getNodeExpandSecretRef

@Stability(Stable)
@Nullable
default SecretReference getNodeExpandSecretRef()

nodeExpandSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeExpandVolume call.

This is an alpha field and requires enabling CSINodeExpandSecret feature gate. This field is optional, may be omitted if no secret is required. If the secret object contains more than one secret, all secrets are passed.

getNodePublishSecretRef

@Stability(Stable)
@Nullable
default SecretReference 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 secrets are passed.

getNodeStageSecretRef

@Stability(Stable)
@Nullable
default SecretReference getNodeStageSecretRef()

nodeStageSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodeStageVolume and NodeStageVolume and NodeUnstageVolume calls.

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

getReadOnly

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

readOnly value to pass to ControllerPublishVolumeRequest.

Defaults to false (read/write).

Default: false (read/write).

getVolumeAttributes

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

volumeAttributes of the volume to publish.

builder

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

Returns:

a CsiPersistentVolumeSource.Builder of CsiPersistentVolumeSource