Struct InstanceGroupMetadata

#[non_exhaustive]
pub struct InstanceGroupMetadata {
    pub failure_message: Option<String>,
    pub availability_zone_id: Option<String>,
    pub capacity_reservation: Option<CapacityReservation>,
    pub subnet_id: Option<String>,
    pub security_group_ids: Option<Vec<String>>,
    pub ami_override: Option<String>,
}

Metadata information about 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.

failure_message: Option<String>

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

availability_zone_id: Option<String>

The ID of the Availability Zone where the instance group is located.

capacity_reservation: Option<CapacityReservation>

Information about the Capacity Reservation used by the instance group.

subnet_id: Option<String>

The ID of the subnet where the instance group is located.

security_group_ids: Option<Vec<String>>

A list of security group IDs associated with the instance group.

ami_override: Option<String>

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

Implementations

impl InstanceGroupMetadata

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

An error message describing why the instance group level operation (such as creating, scaling, or deleting) failed.

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

The ID of the Availability Zone where the instance group is located.

pub fn capacity_reservation(&self) -> Option<&CapacityReservation>

Information about the Capacity Reservation used by the instance group.

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

The ID of the subnet where the instance group is located.

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

A list of security group IDs associated with the 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 .security_group_ids.is_none().

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

If you use a custom Amazon Machine Image (AMI) for the instance group, this field shows the ID of the custom AMI.

impl InstanceGroupMetadata

pub fn builder() -> InstanceGroupMetadataBuilder

Creates a new builder-style object to manufacture InstanceGroupMetadata.

Trait Implementations

impl Clone for InstanceGroupMetadata

fn clone(&self) -> InstanceGroupMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceGroupMetadata

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

Formats the value using the given formatter.

impl PartialEq for InstanceGroupMetadata

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