#[non_exhaustive]pub struct ClusterInstanceGroupDetailsBuilder { /* private fields */ }
Expand description
A builder for ClusterInstanceGroupDetails
.
Implementations§
Source§impl ClusterInstanceGroupDetailsBuilder
impl ClusterInstanceGroupDetailsBuilder
Sourcepub fn current_count(self, input: i32) -> Self
pub fn current_count(self, input: i32) -> Self
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
Sourcepub fn set_current_count(self, input: Option<i32>) -> Self
pub fn set_current_count(self, input: Option<i32>) -> Self
The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.
Sourcepub fn get_current_count(&self) -> &Option<i32>
pub fn get_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, input: i32) -> Self
pub fn target_count(self, input: i32) -> Self
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
Sourcepub fn set_target_count(self, input: Option<i32>) -> Self
pub fn set_target_count(self, input: Option<i32>) -> Self
The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.
Sourcepub fn get_target_count(&self) -> &Option<i32>
pub fn get_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, input: impl Into<String>) -> Self
pub fn instance_group_name(self, input: impl Into<String>) -> Self
The name of the instance group of a SageMaker HyperPod cluster.
Sourcepub fn set_instance_group_name(self, input: Option<String>) -> Self
pub fn set_instance_group_name(self, input: Option<String>) -> Self
The name of the instance group of a SageMaker HyperPod cluster.
Sourcepub fn get_instance_group_name(&self) -> &Option<String>
pub fn get_instance_group_name(&self) -> &Option<String>
The name of the instance group of a SageMaker HyperPod cluster.
Sourcepub fn instance_type(self, input: ClusterInstanceType) -> Self
pub fn instance_type(self, input: ClusterInstanceType) -> Self
The instance type of the instance group of a SageMaker HyperPod cluster.
Sourcepub fn set_instance_type(self, input: Option<ClusterInstanceType>) -> Self
pub fn set_instance_type(self, input: Option<ClusterInstanceType>) -> Self
The instance type of the instance group of a SageMaker HyperPod cluster.
Sourcepub fn get_instance_type(&self) -> &Option<ClusterInstanceType>
pub fn get_instance_type(&self) -> &Option<ClusterInstanceType>
The instance type of the instance group of a SageMaker HyperPod cluster.
Sourcepub fn life_cycle_config(self, input: ClusterLifeCycleConfig) -> Self
pub fn life_cycle_config(self, input: ClusterLifeCycleConfig) -> Self
Details of LifeCycle configuration for the instance group.
Sourcepub fn set_life_cycle_config(
self,
input: Option<ClusterLifeCycleConfig>,
) -> Self
pub fn set_life_cycle_config( self, input: Option<ClusterLifeCycleConfig>, ) -> Self
Details of LifeCycle configuration for the instance group.
Sourcepub fn get_life_cycle_config(&self) -> &Option<ClusterLifeCycleConfig>
pub fn get_life_cycle_config(&self) -> &Option<ClusterLifeCycleConfig>
Details of LifeCycle configuration for the instance group.
Sourcepub fn execution_role(self, input: impl Into<String>) -> Self
pub fn execution_role(self, input: impl Into<String>) -> Self
The execution role for the instance group to assume.
Sourcepub fn set_execution_role(self, input: Option<String>) -> Self
pub fn set_execution_role(self, input: Option<String>) -> Self
The execution role for the instance group to assume.
Sourcepub fn get_execution_role(&self) -> &Option<String>
pub fn get_execution_role(&self) -> &Option<String>
The execution role for the instance group to assume.
Sourcepub fn threads_per_core(self, input: i32) -> Self
pub fn threads_per_core(self, input: i32) -> Self
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 set_threads_per_core(self, input: Option<i32>) -> Self
pub fn set_threads_per_core(self, input: Option<i32>) -> Self
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 get_threads_per_core(&self) -> &Option<i32>
pub fn get_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,
input: ClusterInstanceStorageConfig,
) -> Self
pub fn instance_storage_configs( self, input: ClusterInstanceStorageConfig, ) -> Self
Appends an item to instance_storage_configs
.
To override the contents of this collection use set_instance_storage_configs
.
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
Sourcepub fn set_instance_storage_configs(
self,
input: Option<Vec<ClusterInstanceStorageConfig>>,
) -> Self
pub fn set_instance_storage_configs( self, input: Option<Vec<ClusterInstanceStorageConfig>>, ) -> Self
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
Sourcepub fn get_instance_storage_configs(
&self,
) -> &Option<Vec<ClusterInstanceStorageConfig>>
pub fn get_instance_storage_configs( &self, ) -> &Option<Vec<ClusterInstanceStorageConfig>>
The additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.
Sourcepub fn on_start_deep_health_checks(self, input: DeepHealthCheckType) -> Self
pub fn on_start_deep_health_checks(self, input: DeepHealthCheckType) -> Self
Appends an item to on_start_deep_health_checks
.
To override the contents of this collection use set_on_start_deep_health_checks
.
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
Sourcepub fn set_on_start_deep_health_checks(
self,
input: Option<Vec<DeepHealthCheckType>>,
) -> Self
pub fn set_on_start_deep_health_checks( self, input: Option<Vec<DeepHealthCheckType>>, ) -> Self
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
Sourcepub fn get_on_start_deep_health_checks(
&self,
) -> &Option<Vec<DeepHealthCheckType>>
pub fn get_on_start_deep_health_checks( &self, ) -> &Option<Vec<DeepHealthCheckType>>
A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.
Sourcepub fn status(self, input: InstanceGroupStatus) -> Self
pub fn status(self, input: InstanceGroupStatus) -> Self
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 set_status(self, input: Option<InstanceGroupStatus>) -> Self
pub fn set_status(self, input: Option<InstanceGroupStatus>) -> Self
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 get_status(&self) -> &Option<InstanceGroupStatus>
pub fn get_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, input: impl Into<String>) -> Self
pub fn training_plan_arn(self, input: impl Into<String>) -> Self
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 set_training_plan_arn(self, input: Option<String>) -> Self
pub fn set_training_plan_arn(self, input: Option<String>) -> Self
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 get_training_plan_arn(&self) -> &Option<String>
pub fn get_training_plan_arn(&self) -> &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
.
Sourcepub fn training_plan_status(self, input: impl Into<String>) -> Self
pub fn training_plan_status(self, input: impl Into<String>) -> Self
The current status of the training plan associated with this cluster instance group.
Sourcepub fn set_training_plan_status(self, input: Option<String>) -> Self
pub fn set_training_plan_status(self, input: Option<String>) -> Self
The current status of the training plan associated with this cluster instance group.
Sourcepub fn get_training_plan_status(&self) -> &Option<String>
pub fn get_training_plan_status(&self) -> &Option<String>
The current status of the training plan associated with this cluster instance group.
Sourcepub fn override_vpc_config(self, input: VpcConfig) -> Self
pub fn override_vpc_config(self, input: VpcConfig) -> Self
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
Sourcepub fn set_override_vpc_config(self, input: Option<VpcConfig>) -> Self
pub fn set_override_vpc_config(self, input: Option<VpcConfig>) -> Self
The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.
Sourcepub fn get_override_vpc_config(&self) -> &Option<VpcConfig>
pub fn get_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, input: ScheduledUpdateConfig) -> Self
pub fn scheduled_update_config(self, input: ScheduledUpdateConfig) -> Self
The configuration object of the schedule that SageMaker follows when updating the AMI.
Sourcepub fn set_scheduled_update_config(
self,
input: Option<ScheduledUpdateConfig>,
) -> Self
pub fn set_scheduled_update_config( self, input: Option<ScheduledUpdateConfig>, ) -> Self
The configuration object of the schedule that SageMaker follows when updating the AMI.
Sourcepub fn get_scheduled_update_config(&self) -> &Option<ScheduledUpdateConfig>
pub fn get_scheduled_update_config(&self) -> &Option<ScheduledUpdateConfig>
The configuration object of the schedule that SageMaker follows when updating the AMI.
Sourcepub fn build(self) -> ClusterInstanceGroupDetails
pub fn build(self) -> ClusterInstanceGroupDetails
Consumes the builder and constructs a ClusterInstanceGroupDetails
.
Trait Implementations§
Source§impl Clone for ClusterInstanceGroupDetailsBuilder
impl Clone for ClusterInstanceGroupDetailsBuilder
Source§fn clone(&self) -> ClusterInstanceGroupDetailsBuilder
fn clone(&self) -> ClusterInstanceGroupDetailsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for ClusterInstanceGroupDetailsBuilder
impl Default for ClusterInstanceGroupDetailsBuilder
Source§fn default() -> ClusterInstanceGroupDetailsBuilder
fn default() -> ClusterInstanceGroupDetailsBuilder
Source§impl PartialEq for ClusterInstanceGroupDetailsBuilder
impl PartialEq for ClusterInstanceGroupDetailsBuilder
Source§fn eq(&self, other: &ClusterInstanceGroupDetailsBuilder) -> bool
fn eq(&self, other: &ClusterInstanceGroupDetailsBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for ClusterInstanceGroupDetailsBuilder
Auto Trait Implementations§
impl Freeze for ClusterInstanceGroupDetailsBuilder
impl RefUnwindSafe for ClusterInstanceGroupDetailsBuilder
impl Send for ClusterInstanceGroupDetailsBuilder
impl Sync for ClusterInstanceGroupDetailsBuilder
impl Unpin for ClusterInstanceGroupDetailsBuilder
impl UnwindSafe for ClusterInstanceGroupDetailsBuilder
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);