Struct ClusterSummary

#[non_exhaustive]
pub struct ClusterSummary {
    pub cluster_arn: Option<String>,
    pub cluster_name: Option<String>,
    pub creation_time: Option<DateTime>,
    pub cluster_status: Option<ClusterStatus>,
    pub training_plan_arns: Option<Vec<String>>,
}

Lists a summary of the properties of 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.

cluster_arn: Option<String>

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

cluster_name: Option<String>

The name of the SageMaker HyperPod cluster.

creation_time: Option<DateTime>

The time when the SageMaker HyperPod cluster is created.

cluster_status: Option<ClusterStatus>

The status of the SageMaker HyperPod cluster.

training_plan_arns: Option<Vec<String>>

A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

Implementations

impl ClusterSummary

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

The Amazon Resource Name (ARN) of the SageMaker HyperPod cluster.

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

The name of the SageMaker HyperPod cluster.

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

The time when the SageMaker HyperPod cluster is created.

pub fn cluster_status(&self) -> Option<&ClusterStatus>

The status of the SageMaker HyperPod cluster.

pub fn training_plan_arns(&self) -> &[String]

A list of Amazon Resource Names (ARNs) of the training plans associated with this cluster.

For more information about how to reserve GPU capacity for your SageMaker HyperPod clusters using Amazon SageMaker Training Plan, see CreateTrainingPlan .

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .training_plan_arns.is_none().

impl ClusterSummary

pub fn builder() -> ClusterSummaryBuilder

Creates a new builder-style object to manufacture ClusterSummary.

Trait Implementations

impl Clone for ClusterSummary

fn clone(&self) -> ClusterSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterSummary

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

Formats the value using the given formatter.

impl PartialEq for ClusterSummary

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