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

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

Overview

Note:

When making an API call, you may pass CreateFileSystemOntapConfiguration data as a hash:

{
  automatic_backup_retention_days: 1,
  daily_automatic_backup_start_time: "DailyTime",
  deployment_type: "MULTI_AZ_1", # required, accepts MULTI_AZ_1, SINGLE_AZ_1
  endpoint_ip_address_range: "IpAddressRange",
  fsx_admin_password: "AdminPassword",
  disk_iops_configuration: {
    mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
    iops: 1,
  },
  preferred_subnet_id: "SubnetId",
  route_table_ids: ["RouteTableId"],
  throughput_capacity: 1, # required
  weekly_maintenance_start_time: "WeeklyTime",
}

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

Returns:

  • (Integer)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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.

Returns:

  • (String)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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.



1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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, Amazon FSx selects an unused IP address range for you from the 198.19.* range.

The Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger.

Returns:

  • (String)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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 virtual private cloud (VPC) route tables in which your file system's endpoints will be created. You should specify all 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>)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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, and 2048 MBps.

Returns:

  • (Integer)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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.

Returns:

  • (String)


1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1851

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