Package org.cdk8s.plus23.k8s

Class CsiVolumeSource.Builder

java.lang.Object

org.cdk8s.plus23.k8s.CsiVolumeSource.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CsiVolumeSource>

Enclosing interface:

CsiVolumeSource

@Stability(Stable)
public static final class CsiVolumeSource.Builder
extends Object
implements software.amazon.jsii.Builder<CsiVolumeSource>

A builder for CsiVolumeSource

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CsiVolumeSource	build()	Builds the configured instance.
CsiVolumeSource.Builder	driver(String driver)	Sets the value of CsiVolumeSource.getDriver()
CsiVolumeSource.Builder	fsType(String fsType)	Sets the value of CsiVolumeSource.getFsType()
CsiVolumeSource.Builder	nodePublishSecretRef(LocalObjectReference nodePublishSecretRef)	Sets the value of CsiVolumeSource.getNodePublishSecretRef()
CsiVolumeSource.Builder	readOnly(Boolean readOnly)	Sets the value of CsiVolumeSource.getReadOnly()
CsiVolumeSource.Builder	volumeAttributes(Map<String,String> volumeAttributes)	Sets the value of CsiVolumeSource.getVolumeAttributes()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

driver

@Stability(Stable)
public CsiVolumeSource.Builder driver(String driver)

Sets the value of CsiVolumeSource.getDriver()

Parameters:

driver - Driver is the name of the CSI driver that handles this volume. This parameter is required. Consult with your admin for the correct name as registered in the cluster.

Returns:

this

fsType

@Stability(Stable)
public CsiVolumeSource.Builder fsType(String fsType)

Sets the value of CsiVolumeSource.getFsType()

Parameters:

fsType - Filesystem type 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.

Returns:

this

nodePublishSecretRef

@Stability(Stable)
public CsiVolumeSource.Builder nodePublishSecretRef(LocalObjectReference nodePublishSecretRef)

Sets the value of CsiVolumeSource.getNodePublishSecretRef()

Parameters:

nodePublishSecretRef - 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.

Returns:

this

readOnly

@Stability(Stable)
public CsiVolumeSource.Builder readOnly(Boolean readOnly)

Sets the value of CsiVolumeSource.getReadOnly()

Parameters:

readOnly - Specifies a read-only configuration for the volume. Defaults to false (read/write).

Returns:

this

volumeAttributes

@Stability(Stable)
public CsiVolumeSource.Builder volumeAttributes(Map<String,String> volumeAttributes)

Sets the value of CsiVolumeSource.getVolumeAttributes()

Parameters:

volumeAttributes - VolumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

Returns:

this

build

@Stability(Stable)
public CsiVolumeSource build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CsiVolumeSource>

Returns:

a new instance of CsiVolumeSource

Throws:

NullPointerException - if any required attribute was not provided