UpdateFileSystemOntapConfiguration
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
Contents
- AddRouteTableIds
-
(Multi-AZ only) A list of IDs of new virtual private cloud (VPC) route tables to associate (add) with your Amazon FSx for NetApp ONTAP file system.
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
- AutomaticBackupRetentionDays
-
The number of days to retain automatic backups. Setting this property to
0disables 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.HHis the zero-padded hour of the day (0-23), andMMis the zero-padded minute of the hour. For example,05:00specifies 5 AM daily.Type: String
Length Constraints: Fixed length of 5.
Pattern:
^([01]\d|2[0-3]):?([0-5]\d)$Required: No
- DiskIopsConfiguration
-
The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP 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 an IOPS mode (
AUTOMATICorUSER_PROVISIONED), and in the case ofUSER_PROVISIONEDIOPS, the total number of SSD IOPS provisioned. For more information, see File system storage capacity and IOPS.Type: DiskIopsConfiguration object
Required: No
- EndpointIpv6AddressRange
-
(Multi-AZ only) Specifies the IPv6 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 /118 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, as long as they don't overlap with any subnet.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 43.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{4,43}$Required: No
- FsxAdminPassword
-
Update the password for the
fsxadminuser by entering a new password. You use thefsxadminuser to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see Managing resources using NetApp Application.Type: String
Length Constraints: Minimum length of 8. Maximum length of 50.
Pattern:
^[^\u0000\u0085\u2028\u2029\r\n]{8,50}$Required: No
- HAPairs
-
Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system. If you increase the number of HA pairs for your file system, you must specify proportional increases for
StorageCapacity,Iops, andThroughputCapacity. For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols.Type: Integer
Valid Range: Minimum value of 1. Maximum value of 12.
Required: No
- RemoveRouteTableIds
-
(Multi-AZ only) A list of IDs of existing virtual private cloud (VPC) route tables to disassociate (remove) from your Amazon FSx for NetApp ONTAP file system. You can use the DescribeFileSystems API operation to retrieve the list of VPC route table IDs for a file system.
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
-
Enter a new value to change the amount of throughput capacity for the file system in megabytes per second (MBps). For more information, see Managing throughput capacity 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
ThroughputCapacityandThroughputCapacityPerHAPairare not the same value. -
The value of
ThroughputCapacitywhen divided by the value ofHAPairsis outside of the valid range forThroughputCapacity.
Type: Integer
Valid Range: Minimum value of 8. Maximum value of 100000.
Required: No
-
- ThroughputCapacityPerHAPair
-
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
This field and
ThroughputCapacitycannot be defined in the same API call, but one is required.This field and
ThroughputCapacityare the same for file systems with one HA pair.-
For
SINGLE_AZ_1andMULTI_AZ_1file 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
ThroughputCapacityandThroughputCapacityPerHAPairare not the same value for file systems with one HA pair. -
The value of deployment type is
SINGLE_AZ_2andThroughputCapacity/ThroughputCapacityPerHAPairis not a valid HA pair (a value between 1 and 12). -
The value of
ThroughputCapacityPerHAPairis not a valid value.
Type: Integer
Valid Range: Minimum value of 128. Maximum value of 6144.
Required: No
-
- WeeklyMaintenanceStartTime
-
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
For example,
1:05:00specifies 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: