Class: Aws::FSx::Types::OpenZFSFileSystemConfiguration

Inherits:

Struct

Object
Struct
Aws::FSx::Types::OpenZFSFileSystemConfiguration

show all

Defined in:: gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb

Overview

The configuration for the Amazon FSx for OpenZFS file system.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#automatic_backup_retention_days ⇒ Integer
The number of days to retain automatic backups.
#copy_tags_to_backups ⇒ Boolean
A Boolean value indicating whether tags on the file system should be copied to backups.
#copy_tags_to_volumes ⇒ Boolean
A Boolean value indicating whether tags for the volume should be copied to snapshots.
#daily_automatic_backup_start_time ⇒ String
A recurring daily time, in the format HH:MM.
#deployment_type ⇒ String
Specifies the file-system deployment type.
#disk_iops_configuration ⇒ Types::DiskIopsConfiguration
The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.
#endpoint_ip_address ⇒ String
The IP address of the endpoint that is used to access data or to manage the file system.
#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.
#preferred_subnet_id ⇒ String
Required when DeploymentType is set to MULTI_AZ_1.
#root_volume_id ⇒ String
The ID of the root volume of the OpenZFS file system.
#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 throughput of an Amazon FSx file system, measured in megabytes per second (MBps).
#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 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7259

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_backups ⇒ `Boolean`

A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

Returns:

(Boolean)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_volumes ⇒ `Boolean`

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If it's set to true, all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

Returns:

(Boolean)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  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 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7259

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ `String`

Specifies the file-system deployment type. Amazon FSx for OpenZFS supports  MULTI_AZ_1, SINGLE_AZ_1, and SINGLE_AZ_2.

Returns:

(String)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  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, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

Returns:

(Types::DiskIopsConfiguration)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_ip_address ⇒ `String`

The IP address of the endpoint that is used to access data or to manage the file system.

Returns:

(String)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  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 and Amazon FSx console, Amazon FSx selects an available /28 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.

Returns:

(String)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_subnet_id ⇒ `String`

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)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_id ⇒ `String`

The ID of the root volume of the OpenZFS file system.

Returns:

(String)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  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 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 7259

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_capacity ⇒ `Integer`

The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

Returns:

(Integer)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  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.

Returns:

(String)

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

class OpenZFSFileSystemConfiguration < Struct.new(
  :automatic_backup_retention_days,
  :copy_tags_to_backups,
  :copy_tags_to_volumes,
  :daily_automatic_backup_start_time,
  :deployment_type,
  :throughput_capacity,
  :weekly_maintenance_start_time,
  :disk_iops_configuration,
  :root_volume_id,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids,
  :endpoint_ip_address)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::FSx::Types::OpenZFSFileSystemConfiguration

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_backup_retention_days ⇒ Integer

#copy_tags_to_backups ⇒ Boolean

#copy_tags_to_volumes ⇒ Boolean

#daily_automatic_backup_start_time ⇒ String

#deployment_type ⇒ String

#disk_iops_configuration ⇒ Types::DiskIopsConfiguration

#endpoint_ip_address ⇒ String

#endpoint_ip_address_range ⇒ String

#preferred_subnet_id ⇒ String

#root_volume_id ⇒ String

#route_table_ids ⇒ Array<String>

#throughput_capacity ⇒ Integer

#weekly_maintenance_start_time ⇒ String

#automatic_backup_retention_days ⇒ `Integer`

#copy_tags_to_backups ⇒ `Boolean`

#copy_tags_to_volumes ⇒ `Boolean`

#daily_automatic_backup_start_time ⇒ `String`

#deployment_type ⇒ `String`

#disk_iops_configuration ⇒ `Types::DiskIopsConfiguration`

#endpoint_ip_address ⇒ `String`

#endpoint_ip_address_range ⇒ `String`

#preferred_subnet_id ⇒ `String`

#root_volume_id ⇒ `String`

#route_table_ids ⇒ `Array<String>`

#throughput_capacity ⇒ `Integer`

#weekly_maintenance_start_time ⇒ `String`