Class: Aws::FSx::Types::UpdateFileSystemOntapConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

The configuration updates for an Amazon FSx for NetApp ONTAP file system.

See Also:

Constant Summary collapse

SENSITIVE = 
[:fsx_admin_password]

Instance Attribute Summary collapse

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.

Returns:

  • (Array<String>) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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.

Returns:

  • (Integer) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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.

Returns:

  • (String) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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 File system storage capacity and IOPS.

Returns:



10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#endpoint_ipv_6_address_range ⇒ String

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

Returns:

  • (String) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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 Application.

Returns:

  • (String) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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.

Returns:

  • (Integer) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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.

Returns:

  • (Array<String>) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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.

Returns:

  • (Integer) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  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.

Returns:

  • (Integer) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#weekly_maintenance_start_time ⇒ String

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:00 specifies maintenance at 5 AM Monday.

Returns:

  • (String) 


10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
 
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 10005

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,
  :endpoint_ipv_6_address_range)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end