Struct aws_sdk_sagemaker::types::ClusterNodeDetails

#[non_exhaustive]
pub struct ClusterNodeDetails {
    pub instance_group_name: Option<String>,
    pub instance_id: Option<String>,
    pub instance_status: Option<ClusterInstanceStatusDetails>,
    pub instance_type: Option<ClusterInstanceType>,
    pub launch_time: Option<DateTime>,
    pub life_cycle_config: Option<ClusterLifeCycleConfig>,
    pub threads_per_core: Option<i32>,
    pub instance_storage_configs: Option<Vec<ClusterInstanceStorageConfig>>,
    pub private_primary_ip: Option<String>,
    pub private_dns_hostname: Option<String>,
    pub placement: Option<ClusterInstancePlacement>,
}

Details of an instance (also called a node interchangeably) 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.

instance_group_name: Option<String>

The instance group name in which the instance is.

instance_id: Option<String>

The ID of the instance.

instance_status: Option<ClusterInstanceStatusDetails>

The status of the instance.

instance_type: Option<ClusterInstanceType>

The type of the instance.

launch_time: Option<DateTime>

The time when the instance is launched.

life_cycle_config: Option<ClusterLifeCycleConfig>

The LifeCycle configuration applied to the instance.

threads_per_core: Option<i32>

The number of threads per CPU core you specified under CreateCluster.

instance_storage_configs: Option<Vec<ClusterInstanceStorageConfig>>

The configurations of additional storage specified to the instance group where the instance (node) is launched.

private_primary_ip: Option<String>

The private primary IP address of the SageMaker HyperPod cluster node.

private_dns_hostname: Option<String>

The private DNS hostname of the SageMaker HyperPod cluster node.

placement: Option<ClusterInstancePlacement>

The placement details of the SageMaker HyperPod cluster node.

Implementations

impl ClusterNodeDetails

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

The instance group name in which the instance is.

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

The ID of the instance.

pub fn instance_status(&self) -> Option<&ClusterInstanceStatusDetails>

The status of the instance.

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

The type of the instance.

pub fn launch_time(&self) -> Option<&DateTime>

The time when the instance is launched.

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

The LifeCycle configuration applied to the instance.

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

The number of threads per CPU core you specified under CreateCluster.

pub fn instance_storage_configs(&self) -> &[ClusterInstanceStorageConfig]

The configurations of additional storage specified to the instance group where the instance (node) is launched.

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

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

The private primary IP address of the SageMaker HyperPod cluster node.

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

The private DNS hostname of the SageMaker HyperPod cluster node.

pub fn placement(&self) -> Option<&ClusterInstancePlacement>

The placement details of the SageMaker HyperPod cluster node.

impl ClusterNodeDetails

pub fn builder() -> ClusterNodeDetailsBuilder

Creates a new builder-style object to manufacture ClusterNodeDetails.

Trait Implementations

impl Clone for ClusterNodeDetails

fn clone(&self) -> ClusterNodeDetails

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterNodeDetails

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

Formats the value using the given formatter.

impl PartialEq for ClusterNodeDetails

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ClusterNodeDetails