#[non_exhaustive]pub struct OpenZfsVolumeConfiguration {Show 18 fields
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>,
pub copy_strategy: Option<OpenZfsCopyStrategy>,
}Expand description
The configuration of an Amazon FSx for OpenZFS volume.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
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 gibibytes (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.NONEis 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.
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.
copy_strategy: 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.
Implementations§
Source§impl OpenZfsVolumeConfiguration
impl OpenZfsVolumeConfiguration
Sourcepub fn parent_volume_id(&self) -> Option<&str>
pub fn parent_volume_id(&self) -> Option<&str>
The ID of the parent volume.
Sourcepub fn volume_path(&self) -> Option<&str>
pub fn volume_path(&self) -> Option<&str>
The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
Sourcepub fn storage_capacity_reservation_gib(&self) -> Option<i32>
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.
Sourcepub fn storage_capacity_quota_gib(&self) -> Option<i32>
pub fn storage_capacity_quota_gib(&self) -> Option<i32>
The maximum amount of storage in gibibytes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
Sourcepub fn record_size_kib(&self) -> Option<i32>
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.
Sourcepub fn data_compression_type(&self) -> Option<&OpenZfsDataCompressionType>
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.NONEis 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.
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.
Sourcepub fn origin_snapshot(&self) -> Option<&OpenZfsOriginSnapshotConfiguration>
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.
Sourcepub fn read_only(&self) -> Option<bool>
pub fn read_only(&self) -> Option<bool>
A Boolean value indicating whether the volume is read-only.
Sourcepub fn nfs_exports(&self) -> &[OpenZfsNfsExport]
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().
Sourcepub fn user_and_group_quotas(&self) -> &[OpenZfsUserOrGroupQuota]
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().
Sourcepub fn restore_to_snapshot(&self) -> Option<&str>
pub fn restore_to_snapshot(&self) -> Option<&str>
Specifies the ID of the snapshot to which the volume was restored.
Sourcepub fn delete_intermediate_snaphots(&self) -> Option<bool>
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.
Sourcepub fn delete_cloned_volumes(&self) -> Option<bool>
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.
Sourcepub fn delete_intermediate_data(&self) -> Option<bool>
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.
Sourcepub fn source_snapshot_arn(&self) -> Option<&str>
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.
Sourcepub fn destination_snapshot(&self) -> Option<&str>
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.
Sourcepub fn copy_strategy(&self) -> Option<&OpenZfsCopyStrategy>
pub fn 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.
Source§impl OpenZfsVolumeConfiguration
impl OpenZfsVolumeConfiguration
Sourcepub fn builder() -> OpenZfsVolumeConfigurationBuilder
pub fn builder() -> OpenZfsVolumeConfigurationBuilder
Creates a new builder-style object to manufacture OpenZfsVolumeConfiguration.
Trait Implementations§
Source§impl Clone for OpenZfsVolumeConfiguration
impl Clone for OpenZfsVolumeConfiguration
Source§fn clone(&self) -> OpenZfsVolumeConfiguration
fn clone(&self) -> OpenZfsVolumeConfiguration
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for OpenZfsVolumeConfiguration
impl Debug for OpenZfsVolumeConfiguration
Source§impl PartialEq for OpenZfsVolumeConfiguration
impl PartialEq for OpenZfsVolumeConfiguration
Source§fn eq(&self, other: &OpenZfsVolumeConfiguration) -> bool
fn eq(&self, other: &OpenZfsVolumeConfiguration) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for OpenZfsVolumeConfiguration
Auto Trait Implementations§
impl Freeze for OpenZfsVolumeConfiguration
impl RefUnwindSafe for OpenZfsVolumeConfiguration
impl Send for OpenZfsVolumeConfiguration
impl Sync for OpenZfsVolumeConfiguration
impl Unpin for OpenZfsVolumeConfiguration
impl UnwindSafe for OpenZfsVolumeConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);