#[non_exhaustive]pub struct ClusterInstanceGroupDetails {
pub current_count: Option<i32>,
pub target_count: Option<i32>,
pub instance_group_name: Option<String>,
pub instance_type: Option<ClusterInstanceType>,
pub life_cycle_config: Option<ClusterLifeCycleConfig>,
pub execution_role: Option<String>,
pub threads_per_core: Option<i32>,
pub instance_storage_configs: Option<Vec<ClusterInstanceStorageConfig>>,
pub on_start_deep_health_checks: Option<Vec<DeepHealthCheckType>>,
}
Expand description
Details of an instance group in a SageMaker HyperPod cluster.
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.current_count: Option<i32>
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
target_count: Option<i32>
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
instance_group_name: Option<String>
The name of the instance group of a SageMaker HyperPod cluster.
instance_type: Option<ClusterInstanceType>
The instance type of the instance group of a SageMaker HyperPod cluster.
life_cycle_config: Option<ClusterLifeCycleConfig>
Details of LifeCycle configuration for the instance group.
execution_role: Option<String>
The execution role for the instance group to assume.
threads_per_core: Option<i32>
The number you specified to TreadsPerCore
in CreateCluster
for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
instance_storage_configs: Option<Vec<ClusterInstanceStorageConfig>>
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
on_start_deep_health_checks: Option<Vec<DeepHealthCheckType>>
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
Implementations§
source§impl ClusterInstanceGroupDetails
impl ClusterInstanceGroupDetails
sourcepub fn current_count(&self) -> Option<i32>
pub fn current_count(&self) -> Option<i32>
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
sourcepub fn target_count(&self) -> Option<i32>
pub fn target_count(&self) -> Option<i32>
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
sourcepub fn instance_group_name(&self) -> Option<&str>
pub fn instance_group_name(&self) -> Option<&str>
The name of the instance group of a SageMaker HyperPod cluster.
sourcepub fn instance_type(&self) -> Option<&ClusterInstanceType>
pub fn instance_type(&self) -> Option<&ClusterInstanceType>
The instance type of the instance group of a SageMaker HyperPod cluster.
sourcepub fn life_cycle_config(&self) -> Option<&ClusterLifeCycleConfig>
pub fn life_cycle_config(&self) -> Option<&ClusterLifeCycleConfig>
Details of LifeCycle configuration for the instance group.
sourcepub fn execution_role(&self) -> Option<&str>
pub fn execution_role(&self) -> Option<&str>
The execution role for the instance group to assume.
sourcepub fn threads_per_core(&self) -> Option<i32>
pub fn threads_per_core(&self) -> Option<i32>
The number you specified to TreadsPerCore
in CreateCluster
for enabling or disabling multithreading. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For more information, see the reference table of CPU cores and threads per CPU core per instance type in the Amazon Elastic Compute Cloud User Guide.
sourcepub fn instance_storage_configs(&self) -> &[ClusterInstanceStorageConfig]
pub fn instance_storage_configs(&self) -> &[ClusterInstanceStorageConfig]
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .instance_storage_configs.is_none()
.
sourcepub fn on_start_deep_health_checks(&self) -> &[DeepHealthCheckType]
pub fn on_start_deep_health_checks(&self) -> &[DeepHealthCheckType]
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .on_start_deep_health_checks.is_none()
.
source§impl ClusterInstanceGroupDetails
impl ClusterInstanceGroupDetails
sourcepub fn builder() -> ClusterInstanceGroupDetailsBuilder
pub fn builder() -> ClusterInstanceGroupDetailsBuilder
Creates a new builder-style object to manufacture ClusterInstanceGroupDetails
.
Trait Implementations§
source§impl Clone for ClusterInstanceGroupDetails
impl Clone for ClusterInstanceGroupDetails
source§fn clone(&self) -> ClusterInstanceGroupDetails
fn clone(&self) -> ClusterInstanceGroupDetails
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ClusterInstanceGroupDetails
impl Debug for ClusterInstanceGroupDetails
impl StructuralPartialEq for ClusterInstanceGroupDetails
Auto Trait Implementations§
impl Freeze for ClusterInstanceGroupDetails
impl RefUnwindSafe for ClusterInstanceGroupDetails
impl Send for ClusterInstanceGroupDetails
impl Sync for ClusterInstanceGroupDetails
impl Unpin for ClusterInstanceGroupDetails
impl UnwindSafe for ClusterInstanceGroupDetails
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);