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

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 CreateFileSystemOpenZFSConfiguration data as a hash:

{
  automatic_backup_retention_days: 1,
  copy_tags_to_backups: false,
  copy_tags_to_volumes: false,
  daily_automatic_backup_start_time: "DailyTime",
  deployment_type: "SINGLE_AZ_1", # required, accepts SINGLE_AZ_1
  throughput_capacity: 1, # required
  weekly_maintenance_start_time: "WeeklyTime",
  disk_iops_configuration: {
    mode: "AUTOMATIC", # accepts AUTOMATIC, USER_PROVISIONED
    iops: 1,
  },
  root_volume_configuration: {
    record_size_ki_b: 1,
    data_compression_type: "NONE", # accepts NONE, ZSTD, LZ4
    nfs_exports: [
      {
        client_configurations: [ # required
          {
            clients: "OpenZFSClients", # required
            options: ["OpenZFSNfsExportOption"], # required
          },
        ],
      },
    ],
    user_and_group_quotas: [
      {
        type: "USER", # required, accepts USER, GROUP
        id: 1, # required
        storage_capacity_quota_gi_b: 1, # required
      },
    ],
    copy_tags_to_snapshots: false,
    read_only: false,
  },
}

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

Constant Summary collapse

SENSITIVE =
[]

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)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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

#copy_tags_to_backupsBoolean

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)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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

#copy_tags_to_volumesBoolean

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)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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)
  SENSITIVE = []
  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)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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

#deployment_typeString

Specifies the file system deployment type. Amazon FSx for OpenZFS supports SINGLE_AZ_1. SINGLE_AZ_1 deployment type is configured for redundancy within a single Availability Zone.

Returns:

  • (String)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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

#disk_iops_configurationTypes::DiskIopsConfiguration

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP or Amazon FSx for OpenZFS file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).



1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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

#root_volume_configurationTypes::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.



1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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

#throughput_capacityInteger

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.

Returns:

  • (Integer)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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)
  SENSITIVE = []
  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)


1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 1981

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