Struct BatchReplaceClusterNodesFluentBuilder 

pub struct BatchReplaceClusterNodesFluentBuilder { /* private fields */ }

Fluent builder constructing a request to BatchReplaceClusterNodes.

Replaces specific nodes within a SageMaker HyperPod cluster with new hardware. BatchReplaceClusterNodes terminates the specified instances and provisions new replacement instances with the same configuration but fresh hardware. The Amazon Machine Image (AMI) and instance configuration remain the same.

This operation is useful for recovering from hardware failures or persistent issues that cannot be resolved through a reboot.

• Data Loss Warning: Replacing nodes destroys all instance volumes, including both root and secondary volumes. All data stored on these volumes will be permanently lost and cannot be recovered.

• To safeguard your work, back up your data to Amazon S3 or an FSx for Lustre file system before invoking the API on a worker node group. This will help prevent any potential data loss from the instance root volume. For more information about backup, see Use the backup script provided by SageMaker HyperPod.

• If you want to invoke this API on an existing cluster, you'll first need to patch the cluster by running the UpdateClusterSoftware API. For more information about patching a cluster, see Update the SageMaker HyperPod platform software of a cluster.

• You can replace up to 25 nodes in a single request.

Implementations

impl BatchReplaceClusterNodesFluentBuilder

pub fn as_input(&self) -> &BatchReplaceClusterNodesInputBuilder

Access the BatchReplaceClusterNodes as a reference.

pub async fn send( self, ) -> Result<BatchReplaceClusterNodesOutput, SdkError<BatchReplaceClusterNodesError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<BatchReplaceClusterNodesOutput, BatchReplaceClusterNodesError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn cluster_name(self, input: impl Into<String>) -> Self

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

pub fn set_cluster_name(self, input: Option<String>) -> Self

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

pub fn get_cluster_name(&self) -> &Option<String>

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

pub fn node_ids(self, input: impl Into<String>) -> Self

Appends an item to NodeIds.

To override the contents of this collection use set_node_ids.

A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

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

• For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

pub fn set_node_ids(self, input: Option<Vec<String>>) -> Self

A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

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

• For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

pub fn get_node_ids(&self) -> &Option<Vec<String>>

A list of EC2 instance IDs to replace with new hardware. You can specify between 1 and 25 instance IDs.

Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

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

• For SageMaker HyperPod clusters using the Slurm workload manager, you cannot replace instances that are configured as Slurm controller nodes.

pub fn node_logical_ids(self, input: impl Into<String>) -> Self

Appends an item to NodeLogicalIds.

To override the contents of this collection use set_node_logical_ids.

A list of logical node IDs to replace with new hardware. 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.

• Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

• 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.

pub fn set_node_logical_ids(self, input: Option<Vec<String>>) -> Self

A list of logical node IDs to replace with new hardware. 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.

• Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

• 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.

pub fn get_node_logical_ids(&self) -> &Option<Vec<String>>

A list of logical node IDs to replace with new hardware. 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.

• Replace operations destroy all instance volumes (root and secondary). Ensure you have backed up any important data before proceeding.

• 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.

Trait Implementations

impl Clone for BatchReplaceClusterNodesFluentBuilder

fn clone(&self) -> BatchReplaceClusterNodesFluentBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchReplaceClusterNodesFluentBuilder

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

Formats the value using the given formatter.