OntapFileSystemConfiguration

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 is 30.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 90.

Required: No

A 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.

Type: String

Length Constraints: Fixed length of 5.

Pattern: ^([01]\d|2[0-3]):?([0-5]\d)$

Required: No

Specifies the FSx for ONTAP file system deployment type in use in the file system.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing Multi-AZ or Single-AZ file system deployment.

Type: String

Valid Values: MULTI_AZ_1 | SINGLE_AZ_1 | SINGLE_AZ_2

Required: No

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

Type: DiskIopsConfiguration object

Required: No

(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, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables.

Type: String

Length Constraints: Minimum length of 9. Maximum length of 17.

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{9,17}$

Required: No

The Management and Intercluster endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.

Type: FileSystemEndpoints object

Required: No

You can use the fsxadmin user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response.

Type: String

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

Pattern: ^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$

Required: No

Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of StorageCapacity, Iops, and ThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 12.

Required: No

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

Type: String

Length Constraints: Minimum length of 15. Maximum length of 24.

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

Required: No

(Multi-AZ only) The VPC route tables in which your file system's endpoints are created.

Type: Array of strings

Array Members: Maximum number of 50 items.

Length Constraints: Minimum length of 12. Maximum length of 21.

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

Required: No

The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

Type: Integer

Valid Range: Minimum value of 8. Maximum value of 100000.

Required: No

Use to choose the throughput capacity per HA pair. When the value of HAPairs is equal to 1, the value of ThroughputCapacityPerHAPair is the total throughput for the file system.

This field and ThroughputCapacity cannot be defined in the same API call, but one is required.

This field and ThroughputCapacity are the same for file systems with one HA pair.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

Type: Integer

Valid Range: Minimum value of 128. Maximum value of 6144.

Required: No

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), and MM is the zero-padded minute of the hour.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

Type: String

Length Constraints: Fixed length of 7.

Pattern: ^[1-7]:([01]\d|2[0-3]):?([0-5]\d)$

Required: No