@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class OpenZFSVolumeConfiguration extends Object implements Serializable, Cloneable, StructuredPojo
The configuration of an Amazon FSx for OpenZFS volume.
Constructor and Description |
---|
OpenZFSVolumeConfiguration() |
Modifier and Type | Method and Description |
---|---|
OpenZFSVolumeConfiguration |
clone() |
boolean |
equals(Object obj) |
Boolean |
getCopyTagsToSnapshots()
A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
String |
getDataCompressionType()
Specifies the method used to compress the data on the volume.
|
List<OpenZFSNfsExport> |
getNfsExports()
The configuration object for mounting a Network File System (NFS) file system.
|
OpenZFSOriginSnapshotConfiguration |
getOriginSnapshot()
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
|
String |
getParentVolumeId()
The ID of the parent volume.
|
Boolean |
getReadOnly()
A Boolean value indicating whether the volume is read-only.
|
Integer |
getRecordSizeKiB()
The record size of an OpenZFS volume, in kibibytes (KiB).
|
Integer |
getStorageCapacityQuotaGiB()
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
|
Integer |
getStorageCapacityReservationGiB()
The amount of storage in gibibytes (GiB) to reserve from the parent volume.
|
List<OpenZFSUserOrGroupQuota> |
getUserAndGroupQuotas()
An object specifying how much storage users or groups can use on the volume.
|
String |
getVolumePath()
The path to the volume from the root volume.
|
int |
hashCode() |
Boolean |
isCopyTagsToSnapshots()
A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
Boolean |
isReadOnly()
A Boolean value indicating whether the volume is read-only.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
void |
setDataCompressionType(String dataCompressionType)
Specifies the method used to compress the data on the volume.
|
void |
setNfsExports(Collection<OpenZFSNfsExport> nfsExports)
The configuration object for mounting a Network File System (NFS) file system.
|
void |
setOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
|
void |
setParentVolumeId(String parentVolumeId)
The ID of the parent volume.
|
void |
setReadOnly(Boolean readOnly)
A Boolean value indicating whether the volume is read-only.
|
void |
setRecordSizeKiB(Integer recordSizeKiB)
The record size of an OpenZFS volume, in kibibytes (KiB).
|
void |
setStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
|
void |
setStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)
The amount of storage in gibibytes (GiB) to reserve from the parent volume.
|
void |
setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
An object specifying how much storage users or groups can use on the volume.
|
void |
setVolumePath(String volumePath)
The path to the volume from the root volume.
|
String |
toString()
Returns a string representation of this object.
|
OpenZFSVolumeConfiguration |
withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
OpenZFSVolumeConfiguration |
withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)
Specifies the method used to compress the data on the volume.
|
OpenZFSVolumeConfiguration |
withDataCompressionType(String dataCompressionType)
Specifies the method used to compress the data on the volume.
|
OpenZFSVolumeConfiguration |
withNfsExports(Collection<OpenZFSNfsExport> nfsExports)
The configuration object for mounting a Network File System (NFS) file system.
|
OpenZFSVolumeConfiguration |
withNfsExports(OpenZFSNfsExport... nfsExports)
The configuration object for mounting a Network File System (NFS) file system.
|
OpenZFSVolumeConfiguration |
withOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
|
OpenZFSVolumeConfiguration |
withParentVolumeId(String parentVolumeId)
The ID of the parent volume.
|
OpenZFSVolumeConfiguration |
withReadOnly(Boolean readOnly)
A Boolean value indicating whether the volume is read-only.
|
OpenZFSVolumeConfiguration |
withRecordSizeKiB(Integer recordSizeKiB)
The record size of an OpenZFS volume, in kibibytes (KiB).
|
OpenZFSVolumeConfiguration |
withStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent.
|
OpenZFSVolumeConfiguration |
withStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)
The amount of storage in gibibytes (GiB) to reserve from the parent volume.
|
OpenZFSVolumeConfiguration |
withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
An object specifying how much storage users or groups can use on the volume.
|
OpenZFSVolumeConfiguration |
withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)
An object specifying how much storage users or groups can use on the volume.
|
OpenZFSVolumeConfiguration |
withVolumePath(String volumePath)
The path to the volume from the root volume.
|
public void setParentVolumeId(String parentVolumeId)
The ID of the parent volume.
parentVolumeId
- The ID of the parent volume.public String getParentVolumeId()
The ID of the parent volume.
public OpenZFSVolumeConfiguration withParentVolumeId(String parentVolumeId)
The ID of the parent volume.
parentVolumeId
- The ID of the parent volume.public void setVolumePath(String volumePath)
The path to the volume from the root volume. For example, fsx/parentVolume/volume1
.
volumePath
- The path to the volume from the root volume. For example, fsx/parentVolume/volume1
.public String getVolumePath()
The path to the volume from the root volume. For example, fsx/parentVolume/volume1
.
fsx/parentVolume/volume1
.public OpenZFSVolumeConfiguration withVolumePath(String volumePath)
The path to the volume from the root volume. For example, fsx/parentVolume/volume1
.
volumePath
- The path to the volume from the root volume. For example, fsx/parentVolume/volume1
.public void setStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
storageCapacityReservationGiB
- The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage
than the parent volume has reserved.public Integer getStorageCapacityReservationGiB()
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
public OpenZFSVolumeConfiguration withStorageCapacityReservationGiB(Integer storageCapacityReservationGiB)
The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved.
storageCapacityReservationGiB
- The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage
than the parent volume has reserved.public void setStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
storageCapacityQuotaGiB
- The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify
a quota larger than the storage on the parent volume.public Integer getStorageCapacityQuotaGiB()
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
public OpenZFSVolumeConfiguration withStorageCapacityQuotaGiB(Integer storageCapacityQuotaGiB)
The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
storageCapacityQuotaGiB
- The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify
a quota larger than the storage on the parent volume.public void setRecordSizeKiB(Integer recordSizeKiB)
The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
recordSizeKiB
- The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256,
512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance
on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.public Integer getRecordSizeKiB()
The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
public OpenZFSVolumeConfiguration withRecordSizeKiB(Integer recordSizeKiB)
The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
recordSizeKiB
- The record size of an OpenZFS volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256,
512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. For guidance
on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.public void setDataCompressionType(String dataCompressionType)
Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
dataCompressionType
- Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm.
Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to
Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
OpenZFSDataCompressionType
public String getDataCompressionType()
Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
NONE
by default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm.
Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to
Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
OpenZFSDataCompressionType
public OpenZFSVolumeConfiguration withDataCompressionType(String dataCompressionType)
Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
dataCompressionType
- Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm.
Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to
Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
OpenZFSDataCompressionType
public OpenZFSVolumeConfiguration withDataCompressionType(OpenZFSDataCompressionType dataCompressionType)
Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared
to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard,
LZ4 is less compute-intensive and delivers higher write throughput speeds.
dataCompressionType
- Specifies the method used to compress the data on the volume. The compression type is NONE
by
default.
NONE
- Doesn't compress the data on the volume. NONE
is the default.
ZSTD
- Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm.
Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4
- Compresses the data in the volume using the LZ4 compression algorithm. Compared to
Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
OpenZFSDataCompressionType
public void setCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false
. If it's set to true
, all tags for the volume are copied to snapshots where the
user doesn't specify tags. If this value is true
and you specify one or more tags, only the
specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
copyTagsToSnapshots
- A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults
to false
. If it's set to true
, all tags for the volume are copied to snapshots
where the user doesn't specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or more tags when creating the
snapshot, no tags are copied from the volume, regardless of this value.public Boolean getCopyTagsToSnapshots()
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false
. If it's set to true
, all tags for the volume are copied to snapshots where the
user doesn't specify tags. If this value is true
and you specify one or more tags, only the
specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
false
. If it's set to true
, all tags for the volume are copied to snapshots
where the user doesn't specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or more tags when creating the
snapshot, no tags are copied from the volume, regardless of this value.public OpenZFSVolumeConfiguration withCopyTagsToSnapshots(Boolean copyTagsToSnapshots)
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false
. If it's set to true
, all tags for the volume are copied to snapshots where the
user doesn't specify tags. If this value is true
and you specify one or more tags, only the
specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
copyTagsToSnapshots
- A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults
to false
. If it's set to true
, all tags for the volume are copied to snapshots
where the user doesn't specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or more tags when creating the
snapshot, no tags are copied from the volume, regardless of this value.public Boolean isCopyTagsToSnapshots()
A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to
false
. If it's set to true
, all tags for the volume are copied to snapshots where the
user doesn't specify tags. If this value is true
and you specify one or more tags, only the
specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are
copied from the volume, regardless of this value.
false
. If it's set to true
, all tags for the volume are copied to snapshots
where the user doesn't specify tags. If this value is true
and you specify one or more tags,
only the specified tags are copied to snapshots. If you specify one or more tags when creating the
snapshot, no tags are copied from the volume, regardless of this value.public void setOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
originSnapshot
- The configuration object that specifies the snapshot to use as the origin of the data for the volume.public OpenZFSOriginSnapshotConfiguration getOriginSnapshot()
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
public OpenZFSVolumeConfiguration withOriginSnapshot(OpenZFSOriginSnapshotConfiguration originSnapshot)
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
originSnapshot
- The configuration object that specifies the snapshot to use as the origin of the data for the volume.public void setReadOnly(Boolean readOnly)
A Boolean value indicating whether the volume is read-only.
readOnly
- A Boolean value indicating whether the volume is read-only.public Boolean getReadOnly()
A Boolean value indicating whether the volume is read-only.
public OpenZFSVolumeConfiguration withReadOnly(Boolean readOnly)
A Boolean value indicating whether the volume is read-only.
readOnly
- A Boolean value indicating whether the volume is read-only.public Boolean isReadOnly()
A Boolean value indicating whether the volume is read-only.
public List<OpenZFSNfsExport> getNfsExports()
The configuration object for mounting a Network File System (NFS) file system.
public void setNfsExports(Collection<OpenZFSNfsExport> nfsExports)
The configuration object for mounting a Network File System (NFS) file system.
nfsExports
- The configuration object for mounting a Network File System (NFS) file system.public OpenZFSVolumeConfiguration withNfsExports(OpenZFSNfsExport... nfsExports)
The configuration object for mounting a Network File System (NFS) file system.
NOTE: This method appends the values to the existing list (if any). Use
setNfsExports(java.util.Collection)
or withNfsExports(java.util.Collection)
if you want to
override the existing values.
nfsExports
- The configuration object for mounting a Network File System (NFS) file system.public OpenZFSVolumeConfiguration withNfsExports(Collection<OpenZFSNfsExport> nfsExports)
The configuration object for mounting a Network File System (NFS) file system.
nfsExports
- The configuration object for mounting a Network File System (NFS) file system.public List<OpenZFSUserOrGroupQuota> getUserAndGroupQuotas()
An object specifying how much storage users or groups can use on the volume.
public void setUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
An object specifying how much storage users or groups can use on the volume.
userAndGroupQuotas
- An object specifying how much storage users or groups can use on the volume.public OpenZFSVolumeConfiguration withUserAndGroupQuotas(OpenZFSUserOrGroupQuota... userAndGroupQuotas)
An object specifying how much storage users or groups can use on the volume.
NOTE: This method appends the values to the existing list (if any). Use
setUserAndGroupQuotas(java.util.Collection)
or withUserAndGroupQuotas(java.util.Collection)
if
you want to override the existing values.
userAndGroupQuotas
- An object specifying how much storage users or groups can use on the volume.public OpenZFSVolumeConfiguration withUserAndGroupQuotas(Collection<OpenZFSUserOrGroupQuota> userAndGroupQuotas)
An object specifying how much storage users or groups can use on the volume.
userAndGroupQuotas
- An object specifying how much storage users or groups can use on the volume.public String toString()
toString
in class Object
Object.toString()
public OpenZFSVolumeConfiguration clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.