Interface BatchReplaceClusterNodesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<BatchReplaceClusterNodesRequest.Builder,BatchReplaceClusterNodesRequest>, SageMakerRequest.Builder, SdkBuilder<BatchReplaceClusterNodesRequest.Builder,BatchReplaceClusterNodesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
BatchReplaceClusterNodesRequest
@Mutable @NotThreadSafe public static interface BatchReplaceClusterNodesRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<BatchReplaceClusterNodesRequest.Builder,BatchReplaceClusterNodesRequest>

  • Method Details

    • clusterName

      BatchReplaceClusterNodesRequest.Builder clusterName(String clusterName)

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

      Parameters:
      clusterName - The name or Amazon Resource Name (ARN) of the SageMaker HyperPod cluster containing the nodes to replace.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeIds

      BatchReplaceClusterNodesRequest.Builder nodeIds(Collection<String> nodeIds)

      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.

      Parameters:
      nodeIds - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeIds

      BatchReplaceClusterNodesRequest.Builder nodeIds(String... nodeIds)

      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.

      Parameters:
      nodeIds - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeLogicalIds

      BatchReplaceClusterNodesRequest.Builder nodeLogicalIds(Collection<String> nodeLogicalIds)

      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.

      Parameters:
      nodeLogicalIds - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nodeLogicalIds

      BatchReplaceClusterNodesRequest.Builder nodeLogicalIds(String... nodeLogicalIds)

      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.

      Parameters:
      nodeLogicalIds - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      BatchReplaceClusterNodesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      BatchReplaceClusterNodesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.