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

Inherits:

Struct

Object
Struct
Aws::FSx::Types::OntapFileSystemConfiguration

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

#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`.
#deployment_type ⇒ String

Specifies the FSx for ONTAP file system deployment type in use in the file system.
#disk_iops_configuration ⇒ Types::DiskIopsConfiguration

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

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.
#endpoints ⇒ Types::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.
#fsx_admin_password ⇒ String

You can use the ‘fsxadmin` user account to access the NetApp ONTAP CLI and REST API.
#ha_pairs ⇒ Integer

Specifies how many high-availability (HA) file server pairs the file system will have.
#preferred_subnet_id ⇒ String

The ID for a subnet.
#route_table_ids ⇒ Array<String>

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

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

Use to choose the throughput capacity per HA pair.
#weekly_maintenance_start_time ⇒ String

A recurring weekly time, in the format ‘D:HH:MM`.

Instance Attribute Details

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

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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,
  :ha_pairs,
  :throughput_capacity_per_ha_pair)
  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)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#deployment_type ⇒ `String`

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

‘MULTI_AZ_1` - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.
‘MULTI_AZ_2` - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.
‘SINGLE_AZ_1` - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.
‘SINGLE_AZ_2` - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#disk_iops_configuration ⇒ `Types::DiskIopsConfiguration`

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

Returns:

(Types::DiskIopsConfiguration)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#endpoint_ip_address_range ⇒ `String`

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

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#endpoints ⇒ `Types::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.

Returns:

(Types::FileSystemEndpoints)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#fsx_admin_password ⇒ `String`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#ha_pairs ⇒ `Integer`

Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of ‘StorageCapacity`, `Iops`, and `ThroughputCapacity`. For more information, see [High-availability (HA) pairs] 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 ‘HAPairs` is less than 1 or greater than 12.
The value of ‘HAPairs` is greater than 1 and the value of `DeploymentType` is `SINGLE_AZ_1`, `MULTI_AZ_1`, or `MULTI_AZ_2`.

[1]: docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html

Returns:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#preferred_subnet_id ⇒ `String`

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)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#route_table_ids ⇒ `Array<String>`

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

Returns:

(Array<String>)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#throughput_capacity ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

#throughput_capacity_per_ha_pair ⇒ `Integer`

Use to choose the throughput capacity per HA pair. When the value of ‘HAPairs` is equal to 1, the value of `ThroughputCapacityPerHAPair` is 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.
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)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

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

Returns:

(String)

# File 'lib/aws-sdk-fsx/types.rb', line 7017

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_backup_retention_days ⇒ Integer

#daily_automatic_backup_start_time ⇒ String

#deployment_type ⇒ String

#disk_iops_configuration ⇒ Types::DiskIopsConfiguration

#endpoint_ip_address_range ⇒ String

#endpoints ⇒ Types::FileSystemEndpoints

#fsx_admin_password ⇒ String

#ha_pairs ⇒ Integer

#preferred_subnet_id ⇒ String

#route_table_ids ⇒ Array<String>

#throughput_capacity ⇒ Integer

#throughput_capacity_per_ha_pair ⇒ Integer

#weekly_maintenance_start_time ⇒ String

#automatic_backup_retention_days ⇒ `Integer`

#daily_automatic_backup_start_time ⇒ `String`

#deployment_type ⇒ `String`

#disk_iops_configuration ⇒ `Types::DiskIopsConfiguration`

#endpoint_ip_address_range ⇒ `String`

#endpoints ⇒ `Types::FileSystemEndpoints`

#fsx_admin_password ⇒ `String`

#ha_pairs ⇒ `Integer`

#preferred_subnet_id ⇒ `String`

#route_table_ids ⇒ `Array<String>`

#throughput_capacity ⇒ `Integer`

#throughput_capacity_per_ha_pair ⇒ `Integer`

#weekly_maintenance_start_time ⇒ `String`