ClusterInstanceGroupDetails

Gets and sets the property ActiveOperations.

A map indicating active operations currently in progress for the instance group of a SageMaker HyperPod cluster. When there is a scaling operation in progress, this map contains a key Scaling with value 1.

Gets and sets the property ActiveSoftwareUpdateConfig.

Gets and sets the property CapacityRequirements.

The instance capacity requirements for the instance group.

Gets and sets the property CurrentCount.

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

Gets and sets the property CurrentImageId.

The ID of the Amazon Machine Image (AMI) currently in use by the instance group.

Gets and sets the property DesiredImageId.

The ID of the Amazon Machine Image (AMI) desired for the instance group.

Gets and sets the property ExecutionRole.

The execution role for the instance group to assume.

Gets and sets the property InstanceGroupName.

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

Gets and sets the property InstanceStorageConfigs.

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

Gets and sets the property InstanceType.

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

Gets and sets the property KubernetesConfig.

The Kubernetes configuration for the instance group that contains labels and taints to be applied for the nodes in this instance group.

Gets and sets the property LifeCycleConfig.

Details of LifeCycle configuration for the instance group.

Gets and sets the property MinCount.

The minimum number of instances that must be available in the instance group of a SageMaker HyperPod cluster before it transitions to InService status.

Gets and sets the property OnStartDeepHealthChecks.

A flag indicating whether deep health checks should be performed when the cluster instance group is created or updated.

Gets and sets the property OverrideVpcConfig.

The customized Amazon VPC configuration at the instance group level that overrides the default Amazon VPC configuration of the SageMaker HyperPod cluster.

Gets and sets the property ScheduledUpdateConfig.

The configuration object of the schedule that SageMaker follows when updating the AMI.

Gets and sets the property SlurmConfig.

The Slurm configuration for the instance group.

Gets and sets the property SoftwareUpdateStatus.

Status of the last software udpate request.

Status transitions follow these possible sequences:

• Pending -> InProgress -> Succeeded

• Pending -> InProgress -> RollbackInProgress -> RollbackComplete

• Pending -> InProgress -> RollbackInProgress -> Failed

Gets and sets the property Status.

The current status of the cluster instance group.

• InService: The instance group is active and healthy.

• Creating: The instance group is being provisioned.

• Updating: The instance group is being updated.

• Failed: The instance group has failed to provision or is no longer healthy.

• Degraded: The instance group is degraded, meaning that some instances have failed to provision or are no longer healthy.

• Deleting: The instance group is being deleted.

Gets and sets the property TargetCount.

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

Gets and sets the property TargetStateCount.

Represents the number of running nodes using the desired Image ID.

1. During software update operations: This count shows the number of nodes running on the desired Image ID. If a rollback occurs, the current image ID and desired image ID (both included in the describe cluster response) swap values. The TargetStateCount then shows the number of nodes running on the newly designated desired image ID (which was previously the current image ID).

2. During simultaneous scaling and software update operations: This count shows the number of instances running on the desired image ID, including any new instances created as part of the scaling request. New nodes are always created using the desired image ID, so TargetStateCount reflects the total count of nodes running on the desired image ID, even during rollback scenarios.

Gets and sets the property ThreadsPerCore.

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.

Gets and sets the property TrainingPlanArn.

The Amazon Resource Name (ARN); of the training plan associated with this cluster instance group.

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

Gets and sets the property TrainingPlanStatus.

The current status of the training plan associated with this cluster instance group.