Documentation

The configuration of an Amazon FSx for OpenZFS volume.

See: newOpenZFSVolumeConfiguration smart constructor.

Create a value of OpenZFSVolumeConfiguration 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:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_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:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_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.

$sel:deleteClonedVolumes:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_deleteClonedVolumes - A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

$sel:deleteIntermediateSnaphots:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_deleteIntermediateSnaphots - A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

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

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

$sel:parentVolumeId:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_parentVolumeId - The ID of the parent volume.

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

$sel:recordSizeKiB:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_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/.

$sel:restoreToSnapshot:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_restoreToSnapshot - Specifies the ID of the snapshot to which the volume was restored.

OpenZFSVolumeConfiguration, openZFSVolumeConfiguration_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.

$sel:storageCapacityReservationGiB:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_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.

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

$sel:volumePath:OpenZFSVolumeConfiguration', openZFSVolumeConfiguration_volumePath - The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

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. 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.

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

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.

The ID of the parent volume.

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

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/.

Specifies the ID of the snapshot to which the volume was restored.

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.

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.

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

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.