OntapFileSystemConfiguration
Configuration for the FSx for NetApp ONTAP file system.
Contents
- 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 is30
.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 90.
Required: No
- 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.Type: String
Length Constraints: Fixed length of 5.
Pattern:
^([01]\d|2[0-3]):?([0-5]\d)$
Required: No
- DeploymentType
-
Specifies the FSx for ONTAP file system deployment type in use in the file system.
-
MULTI_AZ_1
- A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. -
MULTI_AZ_2
- A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. -
SINGLE_AZ_1
- A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. -
SINGLE_AZ_2
- A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP 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 | MULTI_AZ_2
Required: No
-
- DiskIopsConfiguration
-
The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.
Type: DiskIopsConfiguration object
Required: No
- EndpointIpAddressRange
-
(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
- Endpoints
-
The
Management
andIntercluster
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
- FsxAdminPassword
-
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
- HAPairs
-
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
, andThroughputCapacity
. 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:
-
The value of
HAPairs
is less than 1 or greater than 12. -
The value of
HAPairs
is greater than 1 and the value ofDeploymentType
isSINGLE_AZ_1
,MULTI_AZ_1
, orMULTI_AZ_2
.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 12.
Required: No
-
- PreferredSubnetId
-
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
- RouteTableIds
-
(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
- ThroughputCapacity
-
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
- ThroughputCapacityPerHAPair
-
Use to choose the throughput capacity per HA pair. When the value of
HAPairs
is equal to 1, the value ofThroughputCapacityPerHAPair
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.-
For
SINGLE_AZ_1
andMULTI_AZ_1
file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. -
For
SINGLE_AZ_2
, valid values are 1536, 3072, or 6144 MBps. -
For
MULTI_AZ_2
, valid values are 384, 768, 1536, 3072, or 6144 MBps.
Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
-
The value of
ThroughputCapacity
andThroughputCapacityPerHAPair
are not the same value. -
The value of deployment type is
SINGLE_AZ_2
andThroughputCapacity
/ThroughputCapacityPerHAPair
is not a valid HA pair (a value between 1 and 12). -
The value of
ThroughputCapacityPerHAPair
is not a valid value.
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 6144.
Required: No
-
- 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.Type: String
Length Constraints: Fixed length of 7.
Pattern:
^[1-7]:([01]\d|2[0-3]):?([0-5]\d)$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: