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

Inherits:

Struct

• Object
• Struct
• Aws::FSx::Types::OpenZFSCreateRootVolumeConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-fsx/types.rb

Overview

The configuration of an Amazon FSx for OpenZFS root volume.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #copy_tags_to_snapshots ⇒ Boolean

  A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume.

• #data_compression_type ⇒ String

  Specifies the method used to compress the data on the volume.

• #nfs_exports ⇒ Array<Types::OpenZFSNfsExport>

  The configuration object for mounting a file system.

• #read_only ⇒ Boolean

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

• #record_size_ki_b ⇒ Integer

  Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).

• #user_and_group_quotas ⇒ Array<Types::OpenZFSUserOrGroupQuota>

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

Instance Attribute Details

#copy_tags_to_snapshots ⇒ Boolean

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)

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

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_type ⇒ String

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)

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

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_exports ⇒ Array<Types::OpenZFSNfsExport>

The configuration object for mounting a file system.

Returns:

• (Array<Types::OpenZFSNfsExport>)

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

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_only ⇒ Boolean

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)

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

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_b ⇒ Integer

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*.

[1]: docs.aws.amazon.com/fsx/latest/OpenZFSGuide/performance.html#performance-tips-zfs

Returns:

• (Integer)

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

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_quotas ⇒ Array<Types::OpenZFSUserOrGroupQuota>

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

Returns:

• (Array<Types::OpenZFSUserOrGroupQuota>)

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

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