#[non_exhaustive]pub struct ClusterInstanceGroupDetails {Show 14 fields
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>>,
pub status: Option<InstanceGroupStatus>,
pub training_plan_arn: Option<String>,
pub training_plan_status: Option<String>,
pub override_vpc_config: Option<VpcConfig>,
pub scheduled_update_config: Option<ScheduledUpdateConfig>,
}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.
status: Option<InstanceGroupStatus>The current status of the cluster instance group.
-
InService: The instance group is active and healthy. -
Creating: The instance group is being provisioned. -
Updating: The instance group is being updated. -
Failed: The instance group has failed to provision or is no longer healthy. -
Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy. -
Deleting: The instance group is being deleted.
training_plan_arn: Option<String>The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
training_plan_status: Option<String>The current status of the training plan associated with this cluster instance group.
override_vpc_config: Option<VpcConfig>The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
scheduled_update_config: Option<ScheduledUpdateConfig>The configuration object of the schedule that SageMaker follows when updating the AMI.
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().
Sourcepub fn status(&self) -> Option<&InstanceGroupStatus>
pub fn status(&self) -> Option<&InstanceGroupStatus>
The current status of the cluster instance group.
-
InService: The instance group is active and healthy. -
Creating: The instance group is being provisioned. -
Updating: The instance group is being updated. -
Failed: The instance group has failed to provision or is no longer healthy. -
Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy. -
Deleting: The instance group is being deleted.
Sourcepub fn training_plan_arn(&self) -> Option<&str>
pub fn training_plan_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.
For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .
Sourcepub fn training_plan_status(&self) -> Option<&str>
pub fn training_plan_status(&self) -> Option<&str>
The current status of the training plan associated with this cluster instance group.
Sourcepub fn override_vpc_config(&self) -> Option<&VpcConfig>
pub fn override_vpc_config(&self) -> Option<&VpcConfig>
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
Sourcepub fn scheduled_update_config(&self) -> Option<&ScheduledUpdateConfig>
pub fn scheduled_update_config(&self) -> Option<&ScheduledUpdateConfig>
The configuration object of the schedule that SageMaker follows when updating the AMI.
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§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ClusterInstanceGroupDetails
impl Debug for ClusterInstanceGroupDetails
Source§impl PartialEq for ClusterInstanceGroupDetails
impl PartialEq for ClusterInstanceGroupDetails
Source§fn eq(&self, other: &ClusterInstanceGroupDetails) -> bool
fn eq(&self, other: &ClusterInstanceGroupDetails) -> bool
self and other values to be equal, and is used by ==.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§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);