AWS::FSx::Volume OpenZFSConfiguration - Amazon CloudFormation
SyntaxProperties
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).

AWS::FSx::Volume OpenZFSConfiguration

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "CopyTagsToSnapshots" : Boolean,
  "DataCompressionType" : String,
  "NfsExports" : [ NfsExports, ... ],
  "Options" : [ String, ... ],
  "OriginSnapshot" : OriginSnapshot,
  "ParentVolumeId" : String,
  "ReadOnly" : Boolean,
  "RecordSizeKiB" : Integer,
  "StorageCapacityQuotaGiB" : Integer,
  "StorageCapacityReservationGiB" : Integer,
  "UserAndGroupQuotas" : [ UserAndGroupQuotas, ... ]
}

Properties

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.

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: String

Allowed values: NONE | ZSTD | LZ4

Update requires: No interruption

NfsExports

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

Required: No

Type: Array of NfsExports

Maximum: 1

Update requires: No interruption

Options

To delete the volume's child volumes, snapshots, and clones, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS.

Required: No

Type: Array of String

Maximum: 1

Update requires: No interruption

OriginSnapshot

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

Required: No

Type: OriginSnapshot

Update requires: Replacement

ParentVolumeId

The ID of the volume to use as the parent volume of the volume that you are creating.

Required: Yes

Type: String

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

Minimum: 23

Maximum: 23

Update requires: Replacement

ReadOnly

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

Required: No

Type: Boolean

Update requires: No interruption

RecordSizeKiB

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size in the Amazon FSx for OpenZFS User Guide.

Required: No

Type: Integer

Minimum: 4

Maximum: 1024

Update requires: No interruption

StorageCapacityQuotaGiB

Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

Required: No

Type: Integer

Minimum: -1

Maximum: 2147483647

Update requires: No interruption

StorageCapacityReservationGiB

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

Required: No

Type: Integer

Minimum: -1

Maximum: 2147483647

Update requires: No interruption

UserAndGroupQuotas

Configures how much storage users and groups can use on the volume.

Required: No

Type: Array of UserAndGroupQuotas

Maximum: 500

Update requires: No interruption