OpenZFSCreateRootVolumeConfiguration - Amazon FSx
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


The configuration of an Amazon FSx for OpenZFS root volume.



A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. 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.

Type: Boolean

Required: No


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


The configuration object for mounting a file system.

Type: Array of OpenZFSNfsExport objects

Array Members: Maximum number of 1 item.

Required: No


A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

Type: Boolean

Required: No


Specifies the record size of an OpenZFS root 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 setting 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


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 Amazon SDKs, see the following: