#[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>>,
}
Expand description
Specifies the configuration of the Amazon FSx for OpenZFS volume that you are creating.
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 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). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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.
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<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§
source§impl CreateOpenZfsVolumeConfiguration
impl CreateOpenZfsVolumeConfiguration
sourcepub fn parent_volume_id(&self) -> Option<&str>
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.
sourcepub fn storage_capacity_reservation_gib(&self) -> Option<i32>
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.
sourcepub fn storage_capacity_quota_gib(&self) -> Option<i32>
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.
sourcepub fn record_size_kib(&self) -> Option<i32>
pub fn record_size_kib(&self) -> Option<i32>
Specifies the suggested block size for a volume in a ZFS dataset, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 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.
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.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.
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<&CreateOpenZfsOriginSnapshotConfiguration>
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.
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]
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()
.
source§impl CreateOpenZfsVolumeConfiguration
impl CreateOpenZfsVolumeConfiguration
sourcepub fn builder() -> CreateOpenZfsVolumeConfigurationBuilder
pub fn builder() -> CreateOpenZfsVolumeConfigurationBuilder
Creates a new builder-style object to manufacture CreateOpenZfsVolumeConfiguration
.
Trait Implementations§
source§impl Clone for CreateOpenZfsVolumeConfiguration
impl Clone for CreateOpenZfsVolumeConfiguration
source§fn clone(&self) -> CreateOpenZfsVolumeConfiguration
fn clone(&self) -> CreateOpenZfsVolumeConfiguration
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl PartialEq for CreateOpenZfsVolumeConfiguration
impl PartialEq for CreateOpenZfsVolumeConfiguration
source§fn eq(&self, other: &CreateOpenZfsVolumeConfiguration) -> bool
fn eq(&self, other: &CreateOpenZfsVolumeConfiguration) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for CreateOpenZfsVolumeConfiguration
Auto Trait Implementations§
impl Freeze for CreateOpenZfsVolumeConfiguration
impl RefUnwindSafe for CreateOpenZfsVolumeConfiguration
impl Send for CreateOpenZfsVolumeConfiguration
impl Sync for CreateOpenZfsVolumeConfiguration
impl Unpin for CreateOpenZfsVolumeConfiguration
impl UnwindSafe for CreateOpenZfsVolumeConfiguration
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> 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 more