Struct CreateOpenZfsVolumeConfiguration

#[non_exhaustive]
pub struct CreateOpenZfsVolumeConfiguration {
    pub parent_volume_id: Option<String>,
    pub storage_capacity_reservation_gib: Option<i32>,
    pub storage_capacity_quota_gib: Option<i32>,
    pub record_size_kib: Option<i32>,
    pub data_compression_type: Option<OpenZfsDataCompressionType>,
    pub copy_tags_to_snapshots: Option<bool>,
    pub origin_snapshot: Option<CreateOpenZfsOriginSnapshotConfiguration>,
    pub read_only: Option<bool>,
    pub nfs_exports: Option<Vec<OpenZfsNfsExport>>,
    pub user_and_group_quotas: Option<Vec<OpenZfsUserOrGroupQuota>>,
}

Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.

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.

parent_volume_id: Option<String>

The ID of the volume to use as the parent volume of the volume that you are creating.

storage_capacity_reservation_gib: Option<i32>

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

storage_capacity_quota_gib: Option<i32>

Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

record_size_kib: Option<i32>

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size 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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

copy_tags_to_snapshots: Option<bool>

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If this value is set to true, and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true, and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.

origin_snapshot: Option<CreateOpenZfsOriginSnapshotConfiguration>

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

read_only: Option<bool>

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

nfs_exports: Option<Vec<OpenZfsNfsExport>>

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

user_and_group_quotas: Option<Vec<OpenZfsUserOrGroupQuota>>

Configures how much storage users and groups can use on the volume.

Implementations

impl CreateOpenZfsVolumeConfiguration

pub fn parent_volume_id(&self) -> Option<&str>

The ID of the volume to use as the parent volume of the volume that you are creating.

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

Specifies the amount of storage in gibibytes (GiB) to reserve from the parent volume. Setting StorageCapacityReservationGiB guarantees that the specified amount of storage space on the parent volume will always be available for the volume. You can't reserve more storage than the parent volume has. To not specify a storage capacity reservation, set this to 0 or -1. For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

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

Sets the maximum storage size in gibibytes (GiB) for the volume. You can specify a quota that is larger than the storage on the parent volume. A volume quota limits the amount of storage that the volume can consume to the configured amount, but does not guarantee the space will be available on the parent volume. To guarantee quota space, you must also set StorageCapacityReservationGiB. To not specify a storage capacity quota, set this to -1.

For more information, see Volume properties in the Amazon FSx for OpenZFS User Guide.

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

Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). For file systems using the Intelligent-Tiering storage class, valid values are 128, 256, 512, 1024, 2048, or 4096 KiB, with a default of 1024 KiB. For all other file systems, valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB, with a default of 128 KiB. We recommend using the default setting for the majority of use cases. Generally, workloads that write in fixed small or large record sizes may benefit from setting a custom record size, like database workloads (small record size) or media streaming workloads (large record size). For additional guidance on when to set a custom record size, see ZFS Record size 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. ZSTD compression provides a higher level of data compression and higher read throughput performance than LZ4 compression.

• LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. LZ4 compression provides a lower level of compression and higher write throughput performance than ZSTD compression.

For more information about volume compression types and the performance of your Amazon FSx for OpenZFS file system, see Tips for maximizing performance File system and volume settings in the Amazon FSx for OpenZFS User Guide.

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

A Boolean value indicating whether tags for the volume should be copied to snapshots. This value defaults to false. If this value is set to true, and you do not specify any tags, all tags for the original volume are copied over to snapshots. If this value is set to true, and you do specify one or more tags, only the specified tags for the original volume are copied over to snapshots. If you specify one or more tags when creating a new snapshot, no tags are copied over from the original volume, regardless of this value.

pub fn origin_snapshot( &self, ) -> Option<&CreateOpenZfsOriginSnapshotConfiguration>

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

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

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

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

The configuration object for mounting a Network File System (NFS) 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]

Configures how much storage users and 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().

impl CreateOpenZfsVolumeConfiguration

pub fn builder() -> CreateOpenZfsVolumeConfigurationBuilder

Creates a new builder-style object to manufacture CreateOpenZfsVolumeConfiguration.

Trait Implementations

impl Clone for CreateOpenZfsVolumeConfiguration

fn clone(&self) -> CreateOpenZfsVolumeConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateOpenZfsVolumeConfiguration

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

Formats the value using the given formatter.

impl PartialEq for CreateOpenZfsVolumeConfiguration

fn eq(&self, other: &CreateOpenZfsVolumeConfiguration) -> 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 CreateOpenZfsVolumeConfiguration