AWS::FSx::FileSystem RootVolumeConfiguration

The configuration of an Amazon FSx for OpenZFS root volume.

Syntax

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

JSON


{
  "CopyTagsToSnapshots" : Boolean,
  "DataCompressionType" : String,
  "NfsExports" : [ NfsExports, ... ],
  "ReadOnly" : Boolean,
  "RecordSizeKiB" : Integer,
  "UserAndGroupQuotas" : [ UserAndGroupQuotas, ... ]
}

YAML


  CopyTagsToSnapshots: Boolean
  DataCompressionType: String
  NfsExports: 
    - NfsExports
  ReadOnly: Boolean
  RecordSizeKiB: Integer
  UserAndGroupQuotas: 
    - UserAndGroupQuotas

Properties

CopyTagsToSnapshots

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.

Required: No

Type: Boolean

Update requires: Replacement

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: Replacement

NfsExports

The configuration object for mounting a file system.

Required: No

Type: Array of NfsExports

Maximum: 1

Update requires: Replacement

ReadOnly

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.

Required: No

Type: Boolean

Update requires: Replacement

RecordSizeKiB

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.

Required: No

Type: Integer

Minimum: 4

Maximum: 1024

Update requires: Replacement

UserAndGroupQuotas