#[non_exhaustive]pub struct CreateOntapVolumeConfiguration {Show 13 fields
pub junction_path: Option<String>,
pub security_style: Option<SecurityStyle>,
pub size_in_megabytes: Option<i32>,
pub storage_efficiency_enabled: Option<bool>,
pub storage_virtual_machine_id: Option<String>,
pub tiering_policy: Option<TieringPolicy>,
pub ontap_volume_type: Option<InputOntapVolumeType>,
pub snapshot_policy: Option<String>,
pub copy_tags_to_backups: Option<bool>,
pub snaplock_configuration: Option<CreateSnaplockConfiguration>,
pub volume_style: Option<VolumeStyle>,
pub aggregate_configuration: Option<CreateAggregateConfiguration>,
pub size_in_bytes: Option<i64>,
}
Expand description
Specifies the configuration of the ONTAP 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.junction_path: Option<String>
Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath
must have a leading forward slash, such as /vol3
.
security_style: Option<SecurityStyle>
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
size_in_megabytes: Option<i32>
Use SizeInBytes
instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
storage_efficiency_enabled: Option<bool>
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
StorageEfficiencyEnabled
is required when creating a RW
volume (OntapVolumeType
set to RW
).
storage_virtual_machine_id: Option<String>
Specifies the ONTAP SVM in which to create the volume.
tiering_policy: Option<TieringPolicy>
Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.
Valid tiering policies are the following:
-
SNAPSHOT_ONLY
- (Default value) moves cold snapshots to the capacity pool storage tier.
-
AUTO
- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
-
ALL
- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
-
NONE
- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
ontap_volume_type: Option<InputOntapVolumeType>
Specifies the type of volume you are creating. Valid values are the following:
-
RW
specifies a read/write volume.RW
is the default. -
DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
snapshot_policy: Option<String>
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
-
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. -
default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule. -
none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
snaplock_configuration: Option<CreateSnaplockConfiguration>
Specifies the SnapLock configuration for an FSx for ONTAP volume.
volume_style: Option<VolumeStyle>
Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
aggregate_configuration: Option<CreateAggregateConfiguration>
Use to specify configuration options for a volume’s storage aggregate or aggregates.
size_in_bytes: Option<i64>
Specifies the configured size of the volume, in bytes.
Implementations§
Source§impl CreateOntapVolumeConfiguration
impl CreateOntapVolumeConfiguration
Sourcepub fn junction_path(&self) -> Option<&str>
pub fn junction_path(&self) -> Option<&str>
Specifies the location in the SVM's namespace where the volume is mounted. This parameter is required. The JunctionPath
must have a leading forward slash, such as /vol3
.
Sourcepub fn security_style(&self) -> Option<&SecurityStyle>
pub fn security_style(&self) -> Option<&SecurityStyle>
Specifies the security style for the volume. If a volume's security style is not specified, it is automatically set to the root volume's security style. The security style determines the type of permissions that FSx for ONTAP uses to control data access. Specify one of the following values:
-
UNIX
if the file system is managed by a UNIX administrator, the majority of users are NFS clients, and an application accessing the data uses a UNIX user as the service account. -
NTFS
if the file system is managed by a Windows administrator, the majority of users are SMB clients, and an application accessing the data uses a Windows user as the service account. -
MIXED
This is an advanced setting. For more information, see the topic What the security styles and their effects are in the NetApp Documentation Center.
For more information, see Volume security style in the FSx for ONTAP User Guide.
Sourcepub fn size_in_megabytes(&self) -> Option<i32>
👎Deprecated: This property is deprecated, use SizeInBytes instead
pub fn size_in_megabytes(&self) -> Option<i32>
Use SizeInBytes
instead. Specifies the size of the volume, in megabytes (MB), that you are creating.
Sourcepub fn storage_efficiency_enabled(&self) -> Option<bool>
pub fn storage_efficiency_enabled(&self) -> Option<bool>
Set to true to enable deduplication, compression, and compaction storage efficiency features on the volume, or set to false to disable them.
StorageEfficiencyEnabled
is required when creating a RW
volume (OntapVolumeType
set to RW
).
Sourcepub fn storage_virtual_machine_id(&self) -> Option<&str>
pub fn storage_virtual_machine_id(&self) -> Option<&str>
Specifies the ONTAP SVM in which to create the volume.
Sourcepub fn tiering_policy(&self) -> Option<&TieringPolicy>
pub fn tiering_policy(&self) -> Option<&TieringPolicy>
Describes the data tiering policy for an ONTAP volume. When enabled, Amazon FSx for ONTAP's intelligent tiering automatically transitions a volume's data between the file system's primary storage and capacity pool storage based on your access patterns.
Valid tiering policies are the following:
-
SNAPSHOT_ONLY
- (Default value) moves cold snapshots to the capacity pool storage tier.
-
AUTO
- moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
-
ALL
- moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
-
NONE
- keeps a volume's data in the primary storage tier, preventing it from being moved to the capacity pool tier.
Sourcepub fn ontap_volume_type(&self) -> Option<&InputOntapVolumeType>
pub fn ontap_volume_type(&self) -> Option<&InputOntapVolumeType>
Specifies the type of volume you are creating. Valid values are the following:
-
RW
specifies a read/write volume.RW
is the default. -
DP
specifies a data-protection volume. ADP
volume is read-only and can be used as the destination of a NetApp SnapMirror relationship.
For more information, see Volume types in the Amazon FSx for NetApp ONTAP User Guide.
Sourcepub fn snapshot_policy(&self) -> Option<&str>
pub fn snapshot_policy(&self) -> Option<&str>
Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
-
default
: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight. -
default-1weekly
: This policy is the same as thedefault
policy except that it only retains one snapshot from the weekly schedule. -
none
: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API.
For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it's set to true, all tags for the volume are copied to all automatic and user-initiated backups 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 backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the volume, regardless of this value.
Sourcepub fn snaplock_configuration(&self) -> Option<&CreateSnaplockConfiguration>
pub fn snaplock_configuration(&self) -> Option<&CreateSnaplockConfiguration>
Specifies the SnapLock configuration for an FSx for ONTAP volume.
Sourcepub fn volume_style(&self) -> Option<&VolumeStyle>
pub fn volume_style(&self) -> Option<&VolumeStyle>
Use to specify the style of an ONTAP volume. FSx for ONTAP offers two styles of volumes that you can use for different purposes, FlexVol and FlexGroup volumes. For more information, see Volume styles in the Amazon FSx for NetApp ONTAP User Guide.
Sourcepub fn aggregate_configuration(&self) -> Option<&CreateAggregateConfiguration>
pub fn aggregate_configuration(&self) -> Option<&CreateAggregateConfiguration>
Use to specify configuration options for a volume’s storage aggregate or aggregates.
Sourcepub fn size_in_bytes(&self) -> Option<i64>
pub fn size_in_bytes(&self) -> Option<i64>
Specifies the configured size of the volume, in bytes.
Source§impl CreateOntapVolumeConfiguration
impl CreateOntapVolumeConfiguration
Sourcepub fn builder() -> CreateOntapVolumeConfigurationBuilder
pub fn builder() -> CreateOntapVolumeConfigurationBuilder
Creates a new builder-style object to manufacture CreateOntapVolumeConfiguration
.
Trait Implementations§
Source§impl Clone for CreateOntapVolumeConfiguration
impl Clone for CreateOntapVolumeConfiguration
Source§fn clone(&self) -> CreateOntapVolumeConfiguration
fn clone(&self) -> CreateOntapVolumeConfiguration
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for CreateOntapVolumeConfiguration
impl PartialEq for CreateOntapVolumeConfiguration
Source§fn eq(&self, other: &CreateOntapVolumeConfiguration) -> bool
fn eq(&self, other: &CreateOntapVolumeConfiguration) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreateOntapVolumeConfiguration
Auto Trait Implementations§
impl Freeze for CreateOntapVolumeConfiguration
impl RefUnwindSafe for CreateOntapVolumeConfiguration
impl Send for CreateOntapVolumeConfiguration
impl Sync for CreateOntapVolumeConfiguration
impl Unpin for CreateOntapVolumeConfiguration
impl UnwindSafe for CreateOntapVolumeConfiguration
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);