Class: Aws::FSx::Types::OpenZFSCreateRootVolumeConfiguration

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

{
  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 configuration of an Amazon FSx for OpenZFS root volume.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#copy_tags_to_snapshotsBoolean

A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. 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)


6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6364

class OpenZFSCreateRootVolumeConfiguration < Struct.new(
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :copy_tags_to_snapshots,
  :read_only)
  SENSITIVE = []
  include Aws::Structure
end

#data_compression_typeString

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

  • NONE - Doesn't compress the data on the volume. NONE is the default.

  • ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.

  • LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

Returns:

  • (String)


6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6364

class OpenZFSCreateRootVolumeConfiguration < Struct.new(
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :copy_tags_to_snapshots,
  :read_only)
  SENSITIVE = []
  include Aws::Structure
end

#nfs_exportsArray<Types::OpenZFSNfsExport>

The configuration object for mounting a file system.

Returns:



6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6364

class OpenZFSCreateRootVolumeConfiguration < Struct.new(
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :copy_tags_to_snapshots,
  :read_only)
  SENSITIVE = []
  include Aws::Structure
end

#read_onlyBoolean

A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

Returns:

  • (Boolean)


6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6364

class OpenZFSCreateRootVolumeConfiguration < Struct.new(
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :copy_tags_to_snapshots,
  :read_only)
  SENSITIVE = []
  include Aws::Structure
end

#record_size_ki_bInteger

Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

Returns:

  • (Integer)


6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6364

class OpenZFSCreateRootVolumeConfiguration < Struct.new(
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :copy_tags_to_snapshots,
  :read_only)
  SENSITIVE = []
  include Aws::Structure
end

#user_and_group_quotasArray<Types::OpenZFSUserOrGroupQuota>

An object specifying how much storage users or groups can use on the volume.

Returns:



6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 6364

class OpenZFSCreateRootVolumeConfiguration < Struct.new(
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :copy_tags_to_snapshots,
  :read_only)
  SENSITIVE = []
  include Aws::Structure
end