org.cdk8s.plus31.AwsElasticBlockStorePersistentVolumeProps Maven / Gradle / Ivy
package org.cdk8s.plus31;
/**
* Properties for AwsElasticBlockStorePersistentVolume.
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.105.0 (build 0a2adcb)", date = "2024-11-15T12:15:24.766Z")
@software.amazon.jsii.Jsii(module = org.cdk8s.plus31.$Module.class, fqn = "cdk8s-plus-31.AwsElasticBlockStorePersistentVolumeProps")
@software.amazon.jsii.Jsii.Proxy(AwsElasticBlockStorePersistentVolumeProps.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface AwsElasticBlockStorePersistentVolumeProps extends software.amazon.jsii.JsiiSerializable, org.cdk8s.plus31.PersistentVolumeProps {
/**
* Unique ID of the persistent disk resource in AWS (Amazon EBS volume).
*
* More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
*
* @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@org.jetbrains.annotations.NotNull java.lang.String getVolumeId();
/**
* 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'
*
* @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getFsType() {
return null;
}
/**
* 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.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Number getPartition() {
return null;
}
/**
* Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
*
* Default: false
*
* @see https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getReadOnly() {
return null;
}
/**
* @return a {@link Builder} of {@link AwsElasticBlockStorePersistentVolumeProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link AwsElasticBlockStorePersistentVolumeProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.String volumeId;
java.lang.String fsType;
java.lang.Number partition;
java.lang.Boolean readOnly;
java.util.List accessModes;
org.cdk8s.plus31.IPersistentVolumeClaim claim;
java.util.List mountOptions;
org.cdk8s.plus31.PersistentVolumeReclaimPolicy reclaimPolicy;
org.cdk8s.Size storage;
java.lang.String storageClassName;
org.cdk8s.plus31.PersistentVolumeMode volumeMode;
org.cdk8s.ApiObjectMetadata metadata;
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getVolumeId}
* @param volumeId Unique ID of the persistent disk resource in AWS (Amazon EBS volume). This parameter is required.
* More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder volumeId(java.lang.String volumeId) {
this.volumeId = volumeId;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getFsType}
* @param fsType Filesystem type of the volume that you want to mount.
* Tip: Ensure that the filesystem type is supported by the host operating system.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder fsType(java.lang.String fsType) {
this.fsType = fsType;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getPartition}
* @param 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).
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder partition(java.lang.Number partition) {
this.partition = partition;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getReadOnly}
* @param readOnly Specify "true" to force and set the ReadOnly property in VolumeMounts to "true".
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder readOnly(java.lang.Boolean readOnly) {
this.readOnly = readOnly;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getAccessModes}
* @param accessModes Contains all ways the volume can be mounted.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@SuppressWarnings("unchecked")
public Builder accessModes(java.util.List accessModes) {
this.accessModes = (java.util.List)accessModes;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getClaim}
* @param claim Part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.
* Expected to be non-nil when bound.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder claim(org.cdk8s.plus31.IPersistentVolumeClaim claim) {
this.claim = claim;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getMountOptions}
* @param mountOptions A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will simply fail if one is invalid.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder mountOptions(java.util.List mountOptions) {
this.mountOptions = mountOptions;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getReclaimPolicy}
* @param 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.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder reclaimPolicy(org.cdk8s.plus31.PersistentVolumeReclaimPolicy reclaimPolicy) {
this.reclaimPolicy = reclaimPolicy;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getStorage}
* @param storage What is the storage capacity of this volume.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder storage(org.cdk8s.Size storage) {
this.storage = storage;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getStorageClassName}
* @param storageClassName Name of StorageClass to which this persistent volume belongs.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder storageClassName(java.lang.String storageClassName) {
this.storageClassName = storageClassName;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getVolumeMode}
* @param volumeMode Defines what type of volume is required by the claim.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder volumeMode(org.cdk8s.plus31.PersistentVolumeMode volumeMode) {
this.volumeMode = volumeMode;
return this;
}
/**
* Sets the value of {@link AwsElasticBlockStorePersistentVolumeProps#getMetadata}
* @param metadata Metadata that all persisted resources must have, which includes all objects users must create.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder metadata(org.cdk8s.ApiObjectMetadata metadata) {
this.metadata = metadata;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link AwsElasticBlockStorePersistentVolumeProps}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public AwsElasticBlockStorePersistentVolumeProps build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link AwsElasticBlockStorePersistentVolumeProps}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements AwsElasticBlockStorePersistentVolumeProps {
private final java.lang.String volumeId;
private final java.lang.String fsType;
private final java.lang.Number partition;
private final java.lang.Boolean readOnly;
private final java.util.List accessModes;
private final org.cdk8s.plus31.IPersistentVolumeClaim claim;
private final java.util.List mountOptions;
private final org.cdk8s.plus31.PersistentVolumeReclaimPolicy reclaimPolicy;
private final org.cdk8s.Size storage;
private final java.lang.String storageClassName;
private final org.cdk8s.plus31.PersistentVolumeMode volumeMode;
private final org.cdk8s.ApiObjectMetadata metadata;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.volumeId = software.amazon.jsii.Kernel.get(this, "volumeId", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.fsType = software.amazon.jsii.Kernel.get(this, "fsType", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.partition = software.amazon.jsii.Kernel.get(this, "partition", software.amazon.jsii.NativeType.forClass(java.lang.Number.class));
this.readOnly = software.amazon.jsii.Kernel.get(this, "readOnly", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.accessModes = software.amazon.jsii.Kernel.get(this, "accessModes", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.PersistentVolumeAccessMode.class)));
this.claim = software.amazon.jsii.Kernel.get(this, "claim", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.IPersistentVolumeClaim.class));
this.mountOptions = software.amazon.jsii.Kernel.get(this, "mountOptions", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
this.reclaimPolicy = software.amazon.jsii.Kernel.get(this, "reclaimPolicy", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.PersistentVolumeReclaimPolicy.class));
this.storage = software.amazon.jsii.Kernel.get(this, "storage", software.amazon.jsii.NativeType.forClass(org.cdk8s.Size.class));
this.storageClassName = software.amazon.jsii.Kernel.get(this, "storageClassName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.volumeMode = software.amazon.jsii.Kernel.get(this, "volumeMode", software.amazon.jsii.NativeType.forClass(org.cdk8s.plus31.PersistentVolumeMode.class));
this.metadata = software.amazon.jsii.Kernel.get(this, "metadata", software.amazon.jsii.NativeType.forClass(org.cdk8s.ApiObjectMetadata.class));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
@SuppressWarnings("unchecked")
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.volumeId = java.util.Objects.requireNonNull(builder.volumeId, "volumeId is required");
this.fsType = builder.fsType;
this.partition = builder.partition;
this.readOnly = builder.readOnly;
this.accessModes = (java.util.List)builder.accessModes;
this.claim = builder.claim;
this.mountOptions = builder.mountOptions;
this.reclaimPolicy = builder.reclaimPolicy;
this.storage = builder.storage;
this.storageClassName = builder.storageClassName;
this.volumeMode = builder.volumeMode;
this.metadata = builder.metadata;
}
@Override
public final java.lang.String getVolumeId() {
return this.volumeId;
}
@Override
public final java.lang.String getFsType() {
return this.fsType;
}
@Override
public final java.lang.Number getPartition() {
return this.partition;
}
@Override
public final java.lang.Boolean getReadOnly() {
return this.readOnly;
}
@Override
public final java.util.List getAccessModes() {
return this.accessModes;
}
@Override
public final org.cdk8s.plus31.IPersistentVolumeClaim getClaim() {
return this.claim;
}
@Override
public final java.util.List getMountOptions() {
return this.mountOptions;
}
@Override
public final org.cdk8s.plus31.PersistentVolumeReclaimPolicy getReclaimPolicy() {
return this.reclaimPolicy;
}
@Override
public final org.cdk8s.Size getStorage() {
return this.storage;
}
@Override
public final java.lang.String getStorageClassName() {
return this.storageClassName;
}
@Override
public final org.cdk8s.plus31.PersistentVolumeMode getVolumeMode() {
return this.volumeMode;
}
@Override
public final org.cdk8s.ApiObjectMetadata getMetadata() {
return this.metadata;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
data.set("volumeId", om.valueToTree(this.getVolumeId()));
if (this.getFsType() != null) {
data.set("fsType", om.valueToTree(this.getFsType()));
}
if (this.getPartition() != null) {
data.set("partition", om.valueToTree(this.getPartition()));
}
if (this.getReadOnly() != null) {
data.set("readOnly", om.valueToTree(this.getReadOnly()));
}
if (this.getAccessModes() != null) {
data.set("accessModes", om.valueToTree(this.getAccessModes()));
}
if (this.getClaim() != null) {
data.set("claim", om.valueToTree(this.getClaim()));
}
if (this.getMountOptions() != null) {
data.set("mountOptions", om.valueToTree(this.getMountOptions()));
}
if (this.getReclaimPolicy() != null) {
data.set("reclaimPolicy", om.valueToTree(this.getReclaimPolicy()));
}
if (this.getStorage() != null) {
data.set("storage", om.valueToTree(this.getStorage()));
}
if (this.getStorageClassName() != null) {
data.set("storageClassName", om.valueToTree(this.getStorageClassName()));
}
if (this.getVolumeMode() != null) {
data.set("volumeMode", om.valueToTree(this.getVolumeMode()));
}
if (this.getMetadata() != null) {
data.set("metadata", om.valueToTree(this.getMetadata()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("cdk8s-plus-31.AwsElasticBlockStorePersistentVolumeProps"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
AwsElasticBlockStorePersistentVolumeProps.Jsii$Proxy that = (AwsElasticBlockStorePersistentVolumeProps.Jsii$Proxy) o;
if (!volumeId.equals(that.volumeId)) return false;
if (this.fsType != null ? !this.fsType.equals(that.fsType) : that.fsType != null) return false;
if (this.partition != null ? !this.partition.equals(that.partition) : that.partition != null) return false;
if (this.readOnly != null ? !this.readOnly.equals(that.readOnly) : that.readOnly != null) return false;
if (this.accessModes != null ? !this.accessModes.equals(that.accessModes) : that.accessModes != null) return false;
if (this.claim != null ? !this.claim.equals(that.claim) : that.claim != null) return false;
if (this.mountOptions != null ? !this.mountOptions.equals(that.mountOptions) : that.mountOptions != null) return false;
if (this.reclaimPolicy != null ? !this.reclaimPolicy.equals(that.reclaimPolicy) : that.reclaimPolicy != null) return false;
if (this.storage != null ? !this.storage.equals(that.storage) : that.storage != null) return false;
if (this.storageClassName != null ? !this.storageClassName.equals(that.storageClassName) : that.storageClassName != null) return false;
if (this.volumeMode != null ? !this.volumeMode.equals(that.volumeMode) : that.volumeMode != null) return false;
return this.metadata != null ? this.metadata.equals(that.metadata) : that.metadata == null;
}
@Override
public final int hashCode() {
int result = this.volumeId.hashCode();
result = 31 * result + (this.fsType != null ? this.fsType.hashCode() : 0);
result = 31 * result + (this.partition != null ? this.partition.hashCode() : 0);
result = 31 * result + (this.readOnly != null ? this.readOnly.hashCode() : 0);
result = 31 * result + (this.accessModes != null ? this.accessModes.hashCode() : 0);
result = 31 * result + (this.claim != null ? this.claim.hashCode() : 0);
result = 31 * result + (this.mountOptions != null ? this.mountOptions.hashCode() : 0);
result = 31 * result + (this.reclaimPolicy != null ? this.reclaimPolicy.hashCode() : 0);
result = 31 * result + (this.storage != null ? this.storage.hashCode() : 0);
result = 31 * result + (this.storageClassName != null ? this.storageClassName.hashCode() : 0);
result = 31 * result + (this.volumeMode != null ? this.volumeMode.hashCode() : 0);
result = 31 * result + (this.metadata != null ? this.metadata.hashCode() : 0);
return result;
}
}
}