Struct aws_sdk_fsx::types::OpenZfsVolumeConfiguration

#[non_exhaustive]
pub struct OpenZfsVolumeConfiguration {

    pub parent_volume_id: Option<String>,
    pub volume_path: 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<OpenZfsOriginSnapshotConfiguration>,
    pub read_only: Option<bool>,
    pub nfs_exports: Option<Vec<OpenZfsNfsExport>>,
    pub user_and_group_quotas: Option<Vec<OpenZfsUserOrGroupQuota>>,
    pub restore_to_snapshot: Option<String>,
    pub delete_intermediate_snaphots: Option<bool>,
    pub delete_cloned_volumes: Option<bool>,
    pub delete_intermediate_data: Option<bool>,
    pub source_snapshot_arn: Option<String>,
    pub destination_snapshot: Option<String>,
}

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

parent_volume_id: Option<String>

The ID of the parent volume.

volume_path: Option<String>

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

storage_capacity_reservation_gib: Option<i32>

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.

storage_capacity_quota_gib: Option<i32>

The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

record_size_kib: Option<i32>

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. For guidance on when to set a custom record size, see 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.

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

origin_snapshot: Option<OpenZfsOriginSnapshotConfiguration>

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

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

restore_to_snapshot: Option<String>

Specifies the ID of the snapshot to which the volume was restored.

delete_intermediate_snaphots: Option<bool>

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

delete_cloned_volumes: Option<bool>

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

delete_intermediate_data: Option<bool>

A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

source_snapshot_arn: Option<String>

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

destination_snapshot: Option<String>

The ID of the snapshot that's being copied or was most recently copied to the destination volume.

Implementations

impl OpenZfsVolumeConfiguration

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

The ID of the parent volume.

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

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

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

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.

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

The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.

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

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. For guidance on when to set a custom record size, see 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 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 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 origin_snapshot(&self) -> Option<&OpenZfsOriginSnapshotConfiguration>

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]

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 restore_to_snapshot(&self) -> Option<&str>

Specifies the ID of the snapshot to which the volume was restored.

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

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

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

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

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

A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.

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

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

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

The ID of the snapshot that's being copied or was most recently copied to the destination volume.

impl OpenZfsVolumeConfiguration

pub fn builder() -> OpenZfsVolumeConfigurationBuilder

Creates a new builder-style object to manufacture OpenZfsVolumeConfiguration.

Trait Implementations

impl Clone for OpenZfsVolumeConfiguration

fn clone(&self) -> OpenZfsVolumeConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenZfsVolumeConfiguration

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

Formats the value using the given formatter.

impl PartialEq for OpenZfsVolumeConfiguration

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for OpenZfsVolumeConfiguration