UpdateOpenZFSVolumeConfiguration - Amazon FSx

UpdateOpenZFSVolumeConfiguration

Used to specify changes to the OpenZFS configuration for the volume that you are updating.

Contents

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.

Type: String

Valid Values: NONE | ZSTD | LZ4

Required: No

NfsExports

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

Type: Array of OpenZFSNfsExport objects

Array Members: Maximum number of 1 item.

Required: No

ReadOnly

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

Type: Boolean

Required: No

RecordSizeKiB

Specifies 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. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

Type: Integer

Valid Range: Minimum value of 4. Maximum value of 1024.

Required: No

StorageCapacityQuotaGiB

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

Type: Integer

Valid Range: Minimum value of -1. Maximum value of 2147483647.

Required: No

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. You can specify a value of -1 to unset a volume's storage capacity reservation.

Type: Integer

Valid Range: Minimum value of -1. Maximum value of 2147483647.

Required: No

UserAndGroupQuotas

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

Type: Array of OpenZFSUserOrGroupQuota objects

Array Members: Maximum number of 500 items.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: