We are excited to announce our new API Documentation.
Optional AutomaticThe 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 is 30.
Optional CopyA Boolean value indicating whether tags on the file system should be copied to
backups.
If it's set to true, all tags on the file system are copied to all
automatic backups and any user-initiated backups where the user doesn't specify any
tags. If this value is true 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.
Optional CopyA 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.
Optional DailyA recurring daily time, in the format HH:MM. HH is the
zero-padded hour of the day (0-23), and MM is the zero-padded minute of the
hour. For example, 05:00 specifies 5 AM daily.
Optional DeploymentSpecifies the file-system deployment type. Amazon FSx for OpenZFS supports
 MULTI_AZ_1, SINGLE_AZ_1, and SINGLE_AZ_2.
Optional DiskThe SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
Optional EndpointThe IP address of the endpoint that is used to access data or to manage the file system.
Optional Endpoint(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.
Optional PreferredRequired when DeploymentType is set to MULTI_AZ_1. This
specifies the subnet in which you want the preferred file server to be located.
Optional RootThe ID of the root volume of the OpenZFS file system.
Optional Route(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.
Optional ThroughputThe throughput of an Amazon FSx file system, measured in megabytes per second (MBps).
Optional WeeklyA 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), and MM is
the zero-padded minute of the hour.
For example, 1:05:00 specifies maintenance at 5 AM Monday.
The configuration for the Amazon FSx for OpenZFS file system.