OpenZFSVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS volume.

CopyStrategy

Specifies the strategy used when copying data from the snapshot to the new volume.

CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.
FULL_COPY - Copies all data from the snapshot to the new volume.

Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

Note

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

Type: String

Valid Values: CLONE | FULL_COPY | INCREMENTAL_COPY

Required: No

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

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

DeleteClonedVolumes

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

Type: Boolean

Required: No

DeleteIntermediateData

A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

Type: Boolean

Required: No

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.

Type: Boolean

Required: No

DestinationSnapshot

The ID of the snapshot that's being copied or was most recently copied to the destination volume.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 28.

Pattern: ^((fs)?volsnap-[0-9a-f]{8,})$

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

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.

Type: Integer

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

Required: No

RestoreToSnapshot

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

Type: String

Length Constraints: Minimum length of 11. Maximum length of 28.

Pattern: ^((fs)?volsnap-[0-9a-f]{8,})$

Required: No

SourceSnapshotARN

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify AWS resources. We require an ARN when you need to specify a resource unambiguously across all of AWS. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 512.

Pattern: ^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(?<!-)):){4}(?!/).{0,1024}$

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

OpenZFSVolumeConfiguration

Contents

Note

See Also