Class: Aws::FSx::Types::CreateFileSystemOpenZFSConfiguration

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

Overview

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_backups ⇒ Boolean

A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to ‘false`. If it’s set to ‘true`, all tags for the file system are copied to all automatic and user-initiated backups 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 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) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end

#copy_tags_to_volumes ⇒ Boolean

A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to ‘false`. If it’s set to ‘true`, all tags for the file system are copied to volumes 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 volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

Returns:

  • (Boolean) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  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) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_type ⇒ String

Specifies the file system deployment type. Single AZ deployment types are configured for redundancy within a single Availability Zone in an Amazon Web Services Region . Valid values are the following:

  • ‘MULTI_AZ_1`- Creates file systems with high availability that are configured for Multi-AZ redundancy to tolerate temporary unavailability in Availability Zones (AZs). `Multi_AZ_1` is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

  • ‘SINGLE_AZ_1`- Creates file systems with throughput capacities of 64 - 4,096 MB/s. `Single_AZ_1` is available in all Amazon Web Services Regions where Amazon FSx for OpenZFS is available.

  • ‘SINGLE_AZ_2`- Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache. `Single_AZ_2` is available only in the US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Tokyo), and Europe (Ireland) Amazon Web Services Regions.

For more information, see [Deployment type availability] and

File system performance][2

in the *Amazon FSx for OpenZFS User

Guide*.

[1]: docs.aws.amazon.com/fsx/latest/OpenZFSGuide/availability-durability.html#available-aws-regions [2]: docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#zfs-fs-performance

Returns:

  • (String) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  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:



2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  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) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  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) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end

#root_volume_configuration ⇒ Types::OpenZFSCreateRootVolumeConfiguration

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.

Returns:



2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end

#route_table_ids ⇒ Array<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>) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end

#throughput_capacity ⇒ Integer

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Valid values depend on the DeploymentType you choose, as follows:

  • For ‘MULTI_AZ_1` and `SINGLE_AZ_2`, valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.

  • For ‘SINGLE_AZ_1`, valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

Returns:

  • (Integer) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  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.

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

Returns:

  • (String) 


2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
 
# File 'lib/aws-sdk-fsx/types.rb', line 2278

class CreateFileSystemOpenZFSConfiguration < 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_configuration,
  :preferred_subnet_id,
  :endpoint_ip_address_range,
  :route_table_ids)
  SENSITIVE = []
  include Aws::Structure
end