Class: Aws::FSx::Types::OntapFileSystemConfiguration

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

Overview

Configuration for the FSx for NetApp ONTAP file system.

Constant Summary collapse

SENSITIVE =
[:fsx_admin_password]

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_backup_retention_daysInteger

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)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#daily_automatic_backup_start_timeString

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)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#deployment_typeString

Specifies the FSx for ONTAP file system deployment type in use in the file system.

  • ‘MULTI_AZ_1` - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

  • ‘SINGLE_AZ_1` - A file system configured for Single-AZ redundancy.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to [Choosing Multi-AZ or Single-AZ file system deployment].

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html

Returns:

  • (String)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#disk_iops_configurationTypes::DiskIopsConfiguration

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.



6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#endpoint_ip_address_rangeString

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

Returns:

  • (String)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#endpointsTypes::FileSystemEndpoints

The ‘Management` and `Intercluster` endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror.



6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#fsx_admin_passwordString

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.

Returns:

  • (String)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#preferred_subnet_idString

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

[1]: docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html

Returns:

  • (String)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#route_table_idsArray<String>

(Multi-AZ only) The VPC route tables in which your file system’s endpoints are created.

Returns:

  • (Array<String>)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#throughput_capacityInteger

The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

Returns:

  • (Integer)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end

#weekly_maintenance_start_timeString

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.

[1]: en.wikipedia.org/wiki/ISO_week_date

Returns:

  • (String)


6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
# File 'lib/aws-sdk-fsx/types.rb', line 6457

class OntapFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :endpoints,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :fsx_admin_password)
  SENSITIVE = [:fsx_admin_password]
  include Aws::Structure
end