public static interface CfnVolume.OpenZFSConfigurationProperty
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.fsx.*;
OpenZFSConfigurationProperty openZFSConfigurationProperty = OpenZFSConfigurationProperty.builder()
.parentVolumeId("parentVolumeId")
// the properties below are optional
.copyTagsToSnapshots(false)
.dataCompressionType("dataCompressionType")
.nfsExports(List.of(NfsExportsProperty.builder()
.clientConfigurations(List.of(ClientConfigurationsProperty.builder()
.clients("clients")
.options(List.of("options"))
.build()))
.build()))
.options(List.of("options"))
.originSnapshot(OriginSnapshotProperty.builder()
.copyStrategy("copyStrategy")
.snapshotArn("snapshotArn")
.build())
.readOnly(false)
.recordSizeKiB(123)
.storageCapacityQuotaGiB(123)
.storageCapacityReservationGiB(123)
.userAndGroupQuotas(List.of(UserAndGroupQuotasProperty.builder()
.id(123)
.storageCapacityQuotaGiB(123)
.type("type")
.build()))
.build();
| Modifier and Type | Interface and Description |
|---|---|
static class |
CfnVolume.OpenZFSConfigurationProperty.Builder
A builder for
CfnVolume.OpenZFSConfigurationProperty |
static class |
CfnVolume.OpenZFSConfigurationProperty.Jsii$Proxy
An implementation for
CfnVolume.OpenZFSConfigurationProperty |
| Modifier and Type | Method and Description |
|---|---|
static CfnVolume.OpenZFSConfigurationProperty.Builder |
builder() |
default java.lang.Object |
getCopyTagsToSnapshots()
A Boolean value indicating whether tags for the volume should be copied to snapshots.
|
default java.lang.String |
getDataCompressionType()
Specifies the method used to compress the data on the volume.
|
default java.lang.Object |
getNfsExports()
The configuration object for mounting a Network File System (NFS) file system.
|
default java.util.List<java.lang.String> |
getOptions()
To delete the volume's child volumes, snapshots, and clones, use the string `DELETE_CHILD_VOLUMES_AND_SNAPSHOTS` .
|
default java.lang.Object |
getOriginSnapshot()
The configuration object that specifies the snapshot to use as the origin of the data for the volume.
|
java.lang.String |
getParentVolumeId()
The ID of the volume to use as the parent volume of the volume that you are creating.
|
default java.lang.Object |
getReadOnly()
A Boolean value indicating whether the volume is read-only.
|
default java.lang.Number |
getRecordSizeKiB()
Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB).
|
default java.lang.Number |
getStorageCapacityQuotaGiB()
Sets the maximum storage size in gibibytes (GiB) for the volume.
|
default java.lang.Number |
getStorageCapacityReservationGiB()
Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume.
|
default java.lang.Object |
getUserAndGroupQuotas()
An object specifying how much storage users or groups can use on the volume.
|
java.lang.String getParentVolumeId()
default java.lang.Object getCopyTagsToSnapshots()
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.
default java.lang.String getDataCompressionType()
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.default java.lang.Object getNfsExports()
default java.util.List<java.lang.String> getOptions()
default java.lang.Object getOriginSnapshot()
default java.lang.Object getReadOnly()
default java.lang.Number getRecordSizeKiB()
Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide .
default java.lang.Number getStorageCapacityQuotaGiB()
You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB . To not specify a storage capacity quota, set this to -1 .
For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
default java.lang.Number getStorageCapacityReservationGiB()
Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1 . For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide .
default java.lang.Object getUserAndGroupQuotas()
static CfnVolume.OpenZFSConfigurationProperty.Builder builder()