Struct aws_sdk_sagemaker::types::ClusterInstanceGroupSpecification

#[non_exhaustive]
pub struct ClusterInstanceGroupSpecification {
    pub instance_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>>,
}

The specifications of an instance group that you need to define.

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.

instance_count: Option<i32>

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

instance_group_name: Option<String>

Specifies the name of the instance group.

instance_type: Option<ClusterInstanceType>

Specifies the instance type of the instance group.

life_cycle_config: Option<ClusterLifeCycleConfig>

Specifies the LifeCycle configuration for the instance group.

execution_role: Option<String>

Specifies an IAM execution role to be assumed by the instance group.

threads_per_core: Option<i32>

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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>>

Specifies the additional storage configurations for the instances in the SageMaker HyperPod cluster instance group.

Implementations

impl ClusterInstanceGroupSpecification

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

Specifies the number of instances to add to the instance group of a SageMaker HyperPod cluster.

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

Specifies the name of the instance group.

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

Specifies the instance type of the instance group.

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

Specifies the LifeCycle configuration for the instance group.

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

Specifies an IAM execution role to be assumed by the instance group.

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

Specifies the value for Threads per core. For instance types that support multithreading, you can specify 1 for disabling multithreading and 2 for enabling multithreading. For instance types that doesn't support multithreading, specify 1. 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]

Specifies 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 ClusterInstanceGroupSpecification

pub fn builder() -> ClusterInstanceGroupSpecificationBuilder

Creates a new builder-style object to manufacture ClusterInstanceGroupSpecification.

Trait Implementations

impl Clone for ClusterInstanceGroupSpecification

fn clone(&self) -> ClusterInstanceGroupSpecification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterInstanceGroupSpecification

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

Formats the value using the given formatter.

impl PartialEq for ClusterInstanceGroupSpecification

fn eq(&self, other: &ClusterInstanceGroupSpecification) -> 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 ClusterInstanceGroupSpecification