Class: Aws::FSx::Types::CreateFileSystemOntapConfiguration

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

Overview

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

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)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

class CreateFileSystemOntapConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :fsx_admin_password,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time)
  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)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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

#deployment_typeString

Specifies the FSx for ONTAP file system deployment type to use in creating 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 a file system deployment type].

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

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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

#disk_iops_configurationTypes::DiskIopsConfiguration

The SSD IOPS configuration for the FSx for ONTAP file system.



1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

class CreateFileSystemOntapConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :fsx_admin_password,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time)
  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, as long as they don’t overlap with any subnet.

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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

#fsx_admin_passwordString

The ONTAP administrative password for the ‘fsxadmin` user with which you administer your file system using the NetApp ONTAP CLI and REST API.

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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

#preferred_subnet_idString

Required when ‘DeploymentType` is set to `MULTI_AZ_1`. This specifies the subnet in which you want the preferred file server to be located.

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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

#route_table_idsArray<String>

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC’s default route table.

Returns:

  • (Array<String>)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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

#throughput_capacityInteger

Sets the throughput capacity for the file system that you’re creating. Valid values are 128, 256, 512, 1024, 2048, and 4096 MBps.

Returns:

  • (Integer)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

class CreateFileSystemOntapConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :endpoint_ip_address_range,
  :fsx_admin_password,
  :disk_iops_configuration,
  :preferred_subnet_id,
  :route_table_ids,
  :throughput_capacity,
  :weekly_maintenance_start_time)
  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)


1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
# File 'lib/aws-sdk-fsx/types.rb', line 1872

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