Documentation

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

See: newCreateOpenZFSVolumeConfiguration smart constructor.

Create a value of CreateOpenZFSVolumeConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:copyTagsToSnapshots:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_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.

$sel:dataCompressionType:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the /Amazon FSx for OpenZFS User Guide/.

$sel:nfsExports:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_nfsExports - The configuration object for mounting a Network File System (NFS) file system.

$sel:originSnapshot:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_originSnapshot - The configuration object that specifies the snapshot to use as the origin of the data for the volume.

$sel:readOnly:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_readOnly - A Boolean value indicating whether the volume is read-only.

$sel:recordSizeKiB:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_recordSizeKiB - Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). 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.

CreateOpenZFSVolumeConfiguration, createOpenZFSVolumeConfiguration_storageCapacityQuotaGiB - Sets the maximum storage size in gibibytes (GiB) for the volume. 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.

$sel:storageCapacityReservationGiB:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_storageCapacityReservationGiB - Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. 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.

$sel:userAndGroupQuotas:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_userAndGroupQuotas - An object specifying how much storage users or groups can use on the volume.

$sel:parentVolumeId:CreateOpenZFSVolumeConfiguration', createOpenZFSVolumeConfiguration_parentVolumeId - The ID of the volume to use as the parent volume of the volume that you are creating.

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.

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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.
• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the /Amazon FSx for OpenZFS User Guide/.

The configuration object for mounting a Network File System (NFS) file system.

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

A Boolean value indicating whether the volume is read-only.

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). 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.

Sets the maximum storage size in gibibytes (GiB) for the volume. 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.

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. 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.

An object specifying how much storage users or groups can use on the volume.

The ID of the volume to use as the parent volume of the volume that you are creating.