AWS::FSx::FileSystem OpenZFSConfiguration
The OpenZFS configuration for the file system that's being created.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AutomaticBackupRetentionDays" :
Integer
, "CopyTagsToBackups" :Boolean
, "CopyTagsToVolumes" :Boolean
, "DailyAutomaticBackupStartTime" :String
, "DeploymentType" :String
, "DiskIopsConfiguration" :DiskIopsConfiguration
, "Options" :[ String, ... ]
, "RootVolumeConfiguration" :RootVolumeConfiguration
, "ThroughputCapacity" :Integer
, "WeeklyMaintenanceStartTime" :String
}
YAML
AutomaticBackupRetentionDays:
Integer
CopyTagsToBackups:Boolean
CopyTagsToVolumes:Boolean
DailyAutomaticBackupStartTime:String
DeploymentType:String
DiskIopsConfiguration:DiskIopsConfiguration
Options:- String
RootVolumeConfiguration:RootVolumeConfiguration
ThroughputCapacity:Integer
WeeklyMaintenanceStartTime:String
Properties
AutomaticBackupRetentionDays
-
The number of days to retain automatic backups. Setting this property to
0
disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is0
.Required: No
Type: Integer
Update requires: No interruption
CopyTagsToBackups
-
A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to
false
. If it's set totrue
, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value istrue
, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.Required: No
Type: Boolean
Update requires: No interruption
CopyTagsToVolumes
-
A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to
false
. If it's set totrue
, all tags for the file system are copied to volumes where the user doesn't specify tags. If this value istrue
, and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.Required: No
Type: Boolean
Update requires: No interruption
DailyAutomaticBackupStartTime
-
A recurring daily time, in the format
HH:MM
.HH
is the zero-padded hour of the day (0-23), andMM
is the zero-padded minute of the hour. For example,05:00
specifies 5 AM daily.Required: No
Type: String
Update requires: No interruption
DeploymentType
-
Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an AWS Region . Valid values are the following:
-
SINGLE_AZ_1
- (Default) Creates file systems with throughput capacities of 64 - 4,096 MB/s.Single_AZ_1
is available in all AWS Regions where Amazon FSx for OpenZFS is available, except US West (Oregon). -
SINGLE_AZ_2
- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache.Single_AZ_2
is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), and Europe (Ireland) AWS Regions.
For more information, see: Deployment type availability and File system performance in the Amazon FSx for OpenZFS User Guide.
Required: Yes
Type: String
Allowed values:
SINGLE_AZ_1 | SINGLE_AZ_2
Update requires: Replacement
-
DiskIopsConfiguration
-
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).
Required: No
Type: DiskIopsConfiguration
Update requires: Replacement
Options
-
To delete a file system if there are child volumes present below the root volume, use the string
DELETE_CHILD_VOLUMES_AND_SNAPSHOTS
. If your file system has child volumes and you don't use this option, the delete request will fail.Required: No
Type: List of String
Maximum:
1
Update requires: No interruption
RootVolumeConfiguration
-
The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.
Required: No
Type: RootVolumeConfiguration
Update requires: No interruption
ThroughputCapacity
-
Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values depend on the DeploymentType you choose, as follows:
-
For
SINGLE_AZ_1
, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. -
For
SINGLE_AZ_2
, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MB/s.
You pay for additional throughput capacity that you provision.
Required: No
Type: Integer
Minimum:
8
Maximum:
100000
Update requires: No interruption
-
WeeklyMaintenanceStartTime
-
A recurring weekly time, in the format
D:HH:MM
.D
is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia. HH
is the zero-padded hour of the day (0-23), andMM
is the zero-padded minute of the hour.For example,
1:05:00
specifies maintenance at 5 AM Monday.Required: No
Type: String
Update requires: No interruption