Class: Aws::FSx::Types::UpdateFileSystemOntapConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::FSx::Types::UpdateFileSystemOntapConfiguration
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-fsx/types.rb
Overview
The configuration updates for an Amazon FSx for NetApp ONTAP file system.
Constant Summary collapse
- SENSITIVE =
[:fsx_admin_password]
Instance Attribute Summary collapse
-
#add_route_table_ids ⇒ Array<String>
(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.
-
#automatic_backup_retention_days ⇒ Integer
The number of days to retain automatic backups.
-
#daily_automatic_backup_start_time ⇒ String
A recurring daily time, in the format ‘HH:MM`.
-
#disk_iops_configuration ⇒ Types::DiskIopsConfiguration
The SSD IOPS (input output operations per second) configuration for an Amazon FSx for NetApp ONTAP file system.
-
#fsx_admin_password ⇒ String
Update the password for the ‘fsxadmin` user by entering a new password.
-
#ha_pairs ⇒ Integer
Use to update the number of high-availability (HA) pairs for a second-generation single-AZ file system.
-
#remove_route_table_ids ⇒ Array<String>
(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.
-
#throughput_capacity ⇒ Integer
Enter a new value to change the amount of throughput capacity for the file system in megabytes per second (MBps).
-
#throughput_capacity_per_ha_pair ⇒ Integer
Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.
-
#weekly_maintenance_start_time ⇒ String
A recurring weekly time, in the format ‘D:HH:MM`.
Instance Attribute Details
#add_route_table_ids ⇒ Array<String>
(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.
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#automatic_backup_retention_days ⇒ Integer
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`.
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#daily_automatic_backup_start_time ⇒ String
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.
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#disk_iops_configuration ⇒ Types::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].
[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/increase-primary-storage.html
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#fsx_admin_password ⇒ String
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].
[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-resources-ontap-apps.html
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#ha_pairs ⇒ Integer
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`, and `ThroughputCapacity`. 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].
[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/administering-file-systems.html#HA-pairs [2]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/supported-fsx-clients.html#using-block-storage
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#remove_route_table_ids ⇒ Array<String>
(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 API operation to retrieve the list of VPC route table IDs for a file system.
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#throughput_capacity ⇒ Integer
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`.
[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-throughput-capacity.html
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#throughput_capacity_per_ha_pair ⇒ Integer
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` 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` 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 not a valid HA pair (a value between 1 and 12).
-
The value of ‘ThroughputCapacityPerHAPair` is not a valid value.
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |
#weekly_maintenance_start_time ⇒ String
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.
9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 |
# File 'lib/aws-sdk-fsx/types.rb', line 9256 class UpdateFileSystemOntapConfiguration < Struct.new( :automatic_backup_retention_days, :daily_automatic_backup_start_time, :fsx_admin_password, :weekly_maintenance_start_time, :disk_iops_configuration, :throughput_capacity, :add_route_table_ids, :remove_route_table_ids, :throughput_capacity_per_ha_pair, :ha_pairs) SENSITIVE = [:fsx_admin_password] include Aws::Structure end |