#[non_exhaustive]pub struct ClusterEbsVolumeConfig {
pub volume_size_in_gb: Option<i32>,
pub volume_kms_key_id: Option<String>,
pub root_volume: Option<bool>,
}
Expand description
Defines the configuration for attaching an additional Amazon Elastic Block Store (EBS) volume to each instance of the SageMaker HyperPod cluster instance group. To learn more, see SageMaker HyperPod release notes: June 20, 2024.
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.volume_size_in_gb: Option<i32>
The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker
.
volume_kms_key_id: Option<String>
The ID of a KMS key to encrypt the Amazon EBS volume.
root_volume: Option<bool>
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig
fields to configure both the root and secondary volumes. Set the value to True
if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True
:
-
The configuration is applied to the root volume.
-
You can't specify the
VolumeSizeInGB
field. The size of the root volume is determined for you. -
You must specify a KMS key ID for
VolumeKmsKeyId
to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False
, and the following applies:
-
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
-
You must specify the
VolumeSizeInGB
field. -
You can optionally specify the
VolumeKmsKeyId
to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Implementations§
Source§impl ClusterEbsVolumeConfig
impl ClusterEbsVolumeConfig
Sourcepub fn volume_size_in_gb(&self) -> Option<i32>
pub fn volume_size_in_gb(&self) -> Option<i32>
The size in gigabytes (GB) of the additional EBS volume to be attached to the instances in the SageMaker HyperPod cluster instance group. The additional EBS volume is attached to each instance within the SageMaker HyperPod cluster instance group and mounted to /opt/sagemaker
.
Sourcepub fn volume_kms_key_id(&self) -> Option<&str>
pub fn volume_kms_key_id(&self) -> Option<&str>
The ID of a KMS key to encrypt the Amazon EBS volume.
Sourcepub fn root_volume(&self) -> Option<bool>
pub fn root_volume(&self) -> Option<bool>
Specifies whether the configuration is for the cluster's root or secondary Amazon EBS volume. You can specify two ClusterEbsVolumeConfig
fields to configure both the root and secondary volumes. Set the value to True
if you'd like to provide your own customer managed Amazon Web Services KMS key to encrypt the root volume. When True
:
-
The configuration is applied to the root volume.
-
You can't specify the
VolumeSizeInGB
field. The size of the root volume is determined for you. -
You must specify a KMS key ID for
VolumeKmsKeyId
to encrypt the root volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Otherwise, by default, the value is False
, and the following applies:
-
The configuration is applied to the secondary volume, while the root volume is encrypted with an Amazon Web Services owned key.
-
You must specify the
VolumeSizeInGB
field. -
You can optionally specify the
VolumeKmsKeyId
to encrypt the secondary volume with your own KMS key instead of an Amazon Web Services owned KMS key.
Source§impl ClusterEbsVolumeConfig
impl ClusterEbsVolumeConfig
Sourcepub fn builder() -> ClusterEbsVolumeConfigBuilder
pub fn builder() -> ClusterEbsVolumeConfigBuilder
Creates a new builder-style object to manufacture ClusterEbsVolumeConfig
.
Trait Implementations§
Source§impl Clone for ClusterEbsVolumeConfig
impl Clone for ClusterEbsVolumeConfig
Source§fn clone(&self) -> ClusterEbsVolumeConfig
fn clone(&self) -> ClusterEbsVolumeConfig
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for ClusterEbsVolumeConfig
impl Debug for ClusterEbsVolumeConfig
Source§impl PartialEq for ClusterEbsVolumeConfig
impl PartialEq for ClusterEbsVolumeConfig
impl StructuralPartialEq for ClusterEbsVolumeConfig
Auto Trait Implementations§
impl Freeze for ClusterEbsVolumeConfig
impl RefUnwindSafe for ClusterEbsVolumeConfig
impl Send for ClusterEbsVolumeConfig
impl Sync for ClusterEbsVolumeConfig
impl Unpin for ClusterEbsVolumeConfig
impl UnwindSafe for ClusterEbsVolumeConfig
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);