UpdateFileSystemOntapConfiguration - Amazon FSx

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

DailyAutomaticBackupStartTime

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

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 (AUTOMATIC or USER_PROVISIONED), and in the case of USER_PROVISIONED IOPS, the total number of SSD IOPS provisioned. For more information, see Updating SSD storage capacity and IOPS.

Type: DiskIopsConfiguration object

Required: No

FsxAdminPassword

Update the password for the fsxadmin user by entering a new password. You use the fsxadmin user to access the NetApp ONTAP CLI and REST API to manage your file system resources. For more information, see Managing resources using NetApp Applicaton.

Type: String

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

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

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 ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.

  • The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity.

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 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 and MULTI_AZ_1, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.

  • For SINGLE_AZ_2, valid values are 3072 or 6144 MBps.

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

  • The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.

  • The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is a valid HA pair (a value between 2 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), 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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: