OpenZFSVolumeConfiguration - Amazon FSx

OpenZFSVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS volume.

Contents

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.

Type: Boolean

Required: No

DataCompressionType

The method used to compress the data on the volume. Unless a compression type is specified, volumes inherit the DataCompressionType value of their parent volume.

  • NONE - Doesn't compress the data on the volume.

  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. This algorithm reduces the amount of space used on your volume and has very little impact on compute resources.

Type: String

Valid Values: NONE | ZSTD

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

OriginSnapshot

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

Type: OpenZFSOriginSnapshotConfiguration object

Required: No

ParentVolumeId

The ID of the parent volume.

Type: String

Length Constraints: Fixed length of 23.

Pattern: ^(fsvol-[0-9a-f]{17,})$

Required: No

ReadOnly

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

Type: Boolean

Required: No

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.

Type: Integer

Valid Range: Minimum value of 0. 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.

Type: Integer

Valid Range: Minimum value of 0. 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 100 items.

Required: No

VolumePath

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Pattern: ^[A-za-z0-9\_\.\:\-\/]*$

Required: No

See Also

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