BatchRebootClusterNodesRequest Class

Container for the parameters to the BatchRebootClusterNodes operation. Reboots specific nodes within a SageMaker HyperPod cluster using a soft recovery mechanism. BatchRebootClusterNodes performs a graceful reboot of the specified nodes by calling the Amazon Elastic Compute Cloud RebootInstances API, which attempts to cleanly shut down the operating system before restarting the instance.

This operation is useful for recovering from transient issues or applying certain configuration changes that require a restart.

Rebooting a node may cause temporary service interruption for workloads running on that node. Ensure your workloads can handle node restarts or use appropriate scheduling to minimize impact.
You can reboot up to 25 nodes in a single request.
For SageMaker HyperPod clusters using the Slurm workload manager, ensure rebooting nodes will not disrupt critical cluster operations.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.SageMaker.AmazonSageMakerRequest
      Amazon.SageMaker.Model.BatchRebootClusterNodesRequest

Namespace: Amazon.SageMaker.Model
Assembly: AWSSDK.SageMaker.dll
Version: 3.x.y.z

Syntax

public class BatchRebootClusterNodesRequest : AmazonSageMakerRequest
         IAmazonWebServiceRequest

The BatchRebootClusterNodesRequest type exposes the following members

Constructors

	Name	Description
	BatchRebootClusterNodesRequest()

Properties

Name Type Description

Name	Type	Description
ClusterName	System.String	Gets and sets the property ClusterName. The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to reboot.
NodeIds	System.Collections.Generic.List<System.String>	Gets and sets the property NodeIds. A list of EC2 instance IDs to reboot using soft recovery. You can specify between 1 and 25 instance IDs. Either `NodeIds` or `NodeLogicalIds` must be provided (or both), but at least one is required. Each instance ID must follow the pattern `i-` followed by 17 hexadecimal characters (for example, `i-0123456789abcdef0`).
NodeLogicalIds	System.Collections.Generic.List<System.String>	Gets and sets the property NodeLogicalIds. A list of logical node IDs to reboot using soft recovery. You can specify between 1 and 25 logical node IDs. The `NodeLogicalId` is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned. This parameter is only supported for clusters using `Continuous` as the `NodeProvisioningMode`. For clusters using the default provisioning mode, use `NodeIds` instead. Either `NodeIds` or `NodeLogicalIds` must be provided (or both), but at least one is required.

ClusterName

System.String

Gets and sets the property ClusterName.

The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to reboot.

NodeIds

System.Collections.Generic.List<System.String>

Gets and sets the property NodeIds.

A list of EC2 instance IDs to reboot using soft recovery. You can specify between 1 and 25 instance IDs.

Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.
Each instance ID must follow the pattern i- followed by 17 hexadecimal characters (for example, i-0123456789abcdef0).

NodeLogicalIds

System.Collections.Generic.List<System.String>

Gets and sets the property NodeLogicalIds.

A list of logical node IDs to reboot using soft recovery. You can specify between 1 and 25 logical node IDs.

The NodeLogicalId is a unique identifier that persists throughout the node's lifecycle and can be used to track nodes that are still being provisioned and don't yet have an EC2 instance ID assigned.

This parameter is only supported for clusters using Continuous as the NodeProvisioningMode. For clusters using the default provisioning mode, use NodeIds instead.
Either NodeIds or NodeLogicalIds must be provided (or both), but at least one is required.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5