Class GCEPersistentDiskPersistentVolume.Builder
- java.lang.Object
-
- org.cdk8s.plus23.GCEPersistentDiskPersistentVolume.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<GCEPersistentDiskPersistentVolume>
- Enclosing class:
- GCEPersistentDiskPersistentVolume
@Stability(Stable) public static final class GCEPersistentDiskPersistentVolume.Builder extends Object implements software.amazon.jsii.Builder<GCEPersistentDiskPersistentVolume>
A fluent builder forGCEPersistentDiskPersistentVolume
.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description GCEPersistentDiskPersistentVolume.Builder
accessModes(List<? extends PersistentVolumeAccessMode> accessModes)
Contains all ways the volume can be mounted.GCEPersistentDiskPersistentVolume
build()
GCEPersistentDiskPersistentVolume.Builder
claim(IPersistentVolumeClaim claim)
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.static GCEPersistentDiskPersistentVolume.Builder
create(software.constructs.Construct scope, String id)
GCEPersistentDiskPersistentVolume.Builder
fsType(String fsType)
Filesystem type of the volume that you want to mount.GCEPersistentDiskPersistentVolume.Builder
metadata(org.cdk8s.ApiObjectMetadata metadata)
Metadata that all persisted resources must have, which includes all objects users must create.GCEPersistentDiskPersistentVolume.Builder
mountOptions(List<String> mountOptions)
A list of mount options, e.g.GCEPersistentDiskPersistentVolume.Builder
partition(Number partition)
The partition in the volume that you want to mount.GCEPersistentDiskPersistentVolume.Builder
pdName(String pdName)
Unique name of the PD resource in GCE.GCEPersistentDiskPersistentVolume.Builder
readOnly(Boolean readOnly)
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".GCEPersistentDiskPersistentVolume.Builder
reclaimPolicy(PersistentVolumeReclaimPolicy reclaimPolicy)
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.GCEPersistentDiskPersistentVolume.Builder
storage(org.cdk8s.Size storage)
What is the storage capacity of this volume.GCEPersistentDiskPersistentVolume.Builder
storageClassName(String storageClassName)
Name of StorageClass to which this persistent volume belongs.GCEPersistentDiskPersistentVolume.Builder
volumeMode(PersistentVolumeMode volumeMode)
Defines what type of volume is required by the claim.
-
-
-
Method Detail
-
create
@Stability(Stable) public static GCEPersistentDiskPersistentVolume.Builder create(software.constructs.Construct scope, String id)
- Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
GCEPersistentDiskPersistentVolume.Builder
.
-
metadata
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder metadata(org.cdk8s.ApiObjectMetadata metadata)
Metadata that all persisted resources must have, which includes all objects users must create.- Parameters:
metadata
- Metadata that all persisted resources must have, which includes all objects users must create. This parameter is required.- Returns:
this
-
accessModes
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder accessModes(List<? extends PersistentVolumeAccessMode> accessModes)
Contains all ways the volume can be mounted.Default: - No access modes.
- Parameters:
accessModes
- Contains all ways the volume can be mounted. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes
-
claim
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder claim(IPersistentVolumeClaim claim)
Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.Expected to be non-nil when bound.
Default: - Not bound to a specific claim.
- Parameters:
claim
- Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
-
mountOptions
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder mountOptions(List<String> mountOptions)
A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid.Default: - No options.
- Parameters:
mountOptions
- A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
-
reclaimPolicy
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder reclaimPolicy(PersistentVolumeReclaimPolicy reclaimPolicy)
When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource.The reclaim policy tells the cluster what to do with the volume after it has been released of its claim.
Default: PersistentVolumeReclaimPolicy.RETAIN
- Parameters:
reclaimPolicy
- When a user is done with their volume, they can delete the PVC objects from the API that allows reclamation of the resource. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
-
storage
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder storage(org.cdk8s.Size storage)
What is the storage capacity of this volume.Default: - No specified.
- Parameters:
storage
- What is the storage capacity of this volume. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
-
storageClassName
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder storageClassName(String storageClassName)
Name of StorageClass to which this persistent volume belongs.Default: - Volume does not belong to any storage class.
- Parameters:
storageClassName
- Name of StorageClass to which this persistent volume belongs. This parameter is required.- Returns:
this
-
volumeMode
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder volumeMode(PersistentVolumeMode volumeMode)
Defines what type of volume is required by the claim.Default: VolumeMode.FILE_SYSTEM
- Parameters:
volumeMode
- Defines what type of volume is required by the claim. This parameter is required.- Returns:
this
-
pdName
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder pdName(String pdName)
Unique name of the PD resource in GCE.Used to identify the disk in GCE.
- Parameters:
pdName
- Unique name of the PD resource in GCE. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
-
fsType
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder fsType(String fsType)
Filesystem type of the volume that you want to mount.Tip: Ensure that the filesystem type is supported by the host operating system.
Default: 'ext4'
- Parameters:
fsType
- Filesystem type of the volume that you want to mount. This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
-
partition
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder partition(Number partition)
The partition in the volume that you want to mount.If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
Default: - No partition.
- Parameters:
partition
- The partition in the volume that you want to mount. This parameter is required.- Returns:
this
-
readOnly
@Stability(Stable) public GCEPersistentDiskPersistentVolume.Builder readOnly(Boolean readOnly)
Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".Default: false
- Parameters:
readOnly
- Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". This parameter is required.- Returns:
this
- See Also:
- https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
-
build
@Stability(Stable) public GCEPersistentDiskPersistentVolume build()
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<GCEPersistentDiskPersistentVolume>
-
-