Struct aws_sdk_fsx::types::builders::OpenZfsVolumeConfigurationBuilder

#[non_exhaustive]
pub struct OpenZfsVolumeConfigurationBuilder { /* private fields */ }

A builder for OpenZfsVolumeConfiguration.

Implementations

impl OpenZfsVolumeConfigurationBuilder

pub fn parent_volume_id(self, input: impl Into<String>) -> Self

The ID of the parent volume.

pub fn set_parent_volume_id(self, input: Option<String>) -> Self

The ID of the parent volume.

pub fn get_parent_volume_id(&self) -> &Option<String>

The ID of the parent volume.

pub fn volume_path(self, input: impl Into<String>) -> Self

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

pub fn set_volume_path(self, input: Option<String>) -> Self

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

pub fn get_volume_path(&self) -> &Option<String>

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

pub fn storage_capacity_reservation_gib(self, input: i32) -> Self

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 set_storage_capacity_reservation_gib(self, input: Option<i32>) -> Self

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 get_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, input: i32) -> Self

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 set_storage_capacity_quota_gib(self, input: Option<i32>) -> Self

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 get_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, input: i32) -> Self

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 set_record_size_kib(self, input: Option<i32>) -> Self

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 get_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, input: OpenZfsDataCompressionType) -> Self

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 set_data_compression_type( self, input: Option<OpenZfsDataCompressionType> ) -> Self

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 get_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, input: bool) -> Self

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 set_copy_tags_to_snapshots(self, input: Option<bool>) -> Self

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 get_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, input: OpenZfsOriginSnapshotConfiguration) -> Self

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

pub fn set_origin_snapshot( self, input: Option<OpenZfsOriginSnapshotConfiguration> ) -> Self

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

pub fn get_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, input: bool) -> Self

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

pub fn set_read_only(self, input: Option<bool>) -> Self

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

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

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

pub fn nfs_exports(self, input: OpenZfsNfsExport) -> Self

Appends an item to nfs_exports.

To override the contents of this collection use set_nfs_exports.

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

pub fn set_nfs_exports(self, input: Option<Vec<OpenZfsNfsExport>>) -> Self

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

pub fn get_nfs_exports(&self) -> &Option<Vec<OpenZfsNfsExport>>

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

pub fn user_and_group_quotas(self, input: OpenZfsUserOrGroupQuota) -> Self

Appends an item to user_and_group_quotas.

To override the contents of this collection use set_user_and_group_quotas.

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

pub fn set_user_and_group_quotas( self, input: Option<Vec<OpenZfsUserOrGroupQuota>> ) -> Self

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

pub fn get_user_and_group_quotas(&self) -> &Option<Vec<OpenZfsUserOrGroupQuota>>

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

pub fn restore_to_snapshot(self, input: impl Into<String>) -> Self

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

pub fn set_restore_to_snapshot(self, input: Option<String>) -> Self

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

pub fn get_restore_to_snapshot(&self) -> &Option<String>

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

pub fn delete_intermediate_snaphots(self, input: bool) -> Self

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 set_delete_intermediate_snaphots(self, input: Option<bool>) -> Self

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 get_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, input: bool) -> Self

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

pub fn set_delete_cloned_volumes(self, input: Option<bool>) -> Self

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

pub fn get_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, input: bool) -> Self

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 set_delete_intermediate_data(self, input: Option<bool>) -> Self

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 get_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, input: impl Into<String>) -> Self

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 set_source_snapshot_arn(self, input: Option<String>) -> Self

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 get_source_snapshot_arn(&self) -> &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.

pub fn destination_snapshot(self, input: impl Into<String>) -> Self

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

pub fn set_destination_snapshot(self, input: Option<String>) -> Self

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

pub fn get_destination_snapshot(&self) -> &Option<String>

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

pub fn copy_strategy(self, input: OpenZfsCopyStrategy) -> Self

Specifies the strategy used when copying data from the snapshot to the new volume.

• CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

• FULL_COPY - Copies all data from the snapshot to the new volume.

  Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

pub fn set_copy_strategy(self, input: Option<OpenZfsCopyStrategy>) -> Self

Specifies the strategy used when copying data from the snapshot to the new volume.

• CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

• FULL_COPY - Copies all data from the snapshot to the new volume.

  Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

pub fn get_copy_strategy(&self) -> &Option<OpenZfsCopyStrategy>

Specifies the strategy used when copying data from the snapshot to the new volume.

• CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn't consume disk throughput. However, the origin snapshot can't be deleted if there is a volume using its copied data.

• FULL_COPY - Copies all data from the snapshot to the new volume.

  Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.

The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.

pub fn build(self) -> OpenZfsVolumeConfiguration

Consumes the builder and constructs a OpenZfsVolumeConfiguration.

Trait Implementations

impl Clone for OpenZfsVolumeConfigurationBuilder

fn clone(&self) -> OpenZfsVolumeConfigurationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenZfsVolumeConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for OpenZfsVolumeConfigurationBuilder

fn default() -> OpenZfsVolumeConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for OpenZfsVolumeConfigurationBuilder

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