Struct aws_sdk_sagemaker::types::ClusterInstanceGroupDetails

#[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>>,
}

Details of an instance group in a SageMaker HyperPod cluster.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

Implementations

impl ClusterInstanceGroupDetails

pub fn current_count(&self) -> Option<i32>

The number of instances that are currently in the instance group of a SageMaker HyperPod cluster.

pub fn target_count(&self) -> Option<i32>

The number of instances you specified to add to the instance group of a SageMaker HyperPod cluster.

pub fn instance_group_name(&self) -> Option<&str>

The name of the instance group of a SageMaker HyperPod cluster.

pub fn instance_type(&self) -> Option<&ClusterInstanceType>

The instance type of the instance group of a SageMaker HyperPod cluster.

pub fn life_cycle_config(&self) -> Option<&ClusterLifeCycleConfig>

Details of LifeCycle configuration for the instance group.

pub fn execution_role(&self) -> Option<&str>

The execution role for the instance group to assume.

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.

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().

impl ClusterInstanceGroupDetails

pub fn builder() -> ClusterInstanceGroupDetailsBuilder

Creates a new builder-style object to manufacture ClusterInstanceGroupDetails.

Trait Implementations

impl Clone for ClusterInstanceGroupDetails

fn clone(&self) -> ClusterInstanceGroupDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ClusterInstanceGroupDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ClusterInstanceGroupDetails

fn eq(&self, other: &ClusterInstanceGroupDetails) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ClusterInstanceGroupDetails