Struct OpenZfsCreateRootVolumeConfiguration

#[non_exhaustive]
pub struct OpenZfsCreateRootVolumeConfiguration {
    pub record_size_kib: Option<i32>,
    pub data_compression_type: Option<OpenZfsDataCompressionType>,
    pub nfs_exports: Option<Vec<OpenZfsNfsExport>>,
    pub user_and_group_quotas: Option<Vec<OpenZfsUserOrGroupQuota>>,
    pub copy_tags_to_snapshots: Option<bool>,
    pub read_only: Option<bool>,
}

The configuration of an Amazon FSx for OpenZFS root volume.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

record_size_kib: Option<i32>

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.

data_compression_type: Option<OpenZfsDataCompressionType>

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.

nfs_exports: Option<Vec<OpenZfsNfsExport>>

The configuration object for mounting a file system.

user_and_group_quotas: Option<Vec<OpenZfsUserOrGroupQuota>>

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

copy_tags_to_snapshots: Option<bool>

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.

read_only: Option<bool>

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.

Implementations

impl OpenZfsCreateRootVolumeConfiguration

pub fn record_size_kib(&self) -> Option<i32>

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.

pub fn data_compression_type(&self) -> Option<&OpenZfsDataCompressionType>

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.

pub fn nfs_exports(&self) -> &[OpenZfsNfsExport]

The configuration object for mounting a file system.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .nfs_exports.is_none().

pub fn user_and_group_quotas(&self) -> &[OpenZfsUserOrGroupQuota]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .user_and_group_quotas.is_none().

pub fn copy_tags_to_snapshots(&self) -> Option<bool>

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.

pub fn read_only(&self) -> Option<bool>

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.

impl OpenZfsCreateRootVolumeConfiguration

pub fn builder() -> OpenZfsCreateRootVolumeConfigurationBuilder

Creates a new builder-style object to manufacture OpenZfsCreateRootVolumeConfiguration.

Trait Implementations

impl Clone for OpenZfsCreateRootVolumeConfiguration

fn clone(&self) -> OpenZfsCreateRootVolumeConfiguration

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OpenZfsCreateRootVolumeConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for OpenZfsCreateRootVolumeConfiguration

fn eq(&self, other: &OpenZfsCreateRootVolumeConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OpenZfsCreateRootVolumeConfiguration