Class: Aws::FSx::Types::UpdateOpenZFSVolumeConfiguration

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

{
  storage_capacity_reservation_gi_b: 1,
  storage_capacity_quota_gi_b: 1,
  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
    },
  ],
  read_only: false,
}

Used to specify changes to the OpenZFS configuration for the volume that you are updating.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#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)


8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

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

#nfs_exportsArray<Types::OpenZFSNfsExport>

The configuration object for mounting a Network File System (NFS) file system.

Returns:



8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

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

#read_onlyBoolean

A Boolean value indicating whether the volume is read-only.

Returns:

  • (Boolean)


8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

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

#record_size_ki_bInteger

Specifies the record size of an OpenZFS 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 when to set a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide.

Returns:

  • (Integer)


8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

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

#storage_capacity_quota_gi_bInteger

The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume. You can specify a value of -1 to unset a volume's storage capacity quota.

Returns:

  • (Integer)


8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

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

#storage_capacity_reservation_gi_bInteger

The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can't reserve more storage than the parent volume has reserved. You can specify a value of -1 to unset a volume's storage capacity reservation.

Returns:

  • (Integer)


8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

class UpdateOpenZFSVolumeConfiguration < Struct.new(
  :storage_capacity_reservation_gi_b,
  :storage_capacity_quota_gi_b,
  :record_size_ki_b,
  :data_compression_type,
  :nfs_exports,
  :user_and_group_quotas,
  :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:



8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
# File 'gems/aws-sdk-fsx/lib/aws-sdk-fsx/types.rb', line 8380

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