Interface MoveClusterNodesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<MoveClusterNodesRequest.Builder,,MoveClusterNodesRequest> SageMakerRequest.Builder,SdkBuilder<MoveClusterNodesRequest.Builder,,MoveClusterNodesRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
MoveClusterNodesRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time.instanceCount(Integer instanceCount) The number of nodes to move, from 1 to 50.A list of instance IDs of the nodes to move.nodeIds(Collection<String> nodeIds) A list of instance IDs of the nodes to move.nodeLogicalIds(String... nodeLogicalIds) A list ofNodeLogicalIdsof the nodes to move.nodeLogicalIds(Collection<String> nodeLogicalIds) A list ofNodeLogicalIdsof the nodes to move.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sourceClusterArn(String sourceClusterArn) The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved from.sourceInstanceGroupName(String sourceInstanceGroupName) The name of the instance group in the source cluster that the nodes are moved from.targetClusterArn(String targetClusterArn) The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved to.targetInstanceGroupName(String targetInstanceGroupName) The name of the instance group in the target cluster that the nodes are moved to.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
sourceClusterArn
The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved from.
- Parameters:
sourceClusterArn- The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceInstanceGroupName
The name of the instance group in the source cluster that the nodes are moved from.
- Parameters:
sourceInstanceGroupName- The name of the instance group in the source cluster that the nodes are moved from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetClusterArn
The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved to. The target cluster must be in the same account and Region as the source cluster, and can be the same cluster as the source.
- Parameters:
targetClusterArn- The Amazon Resource Name (ARN) of the HyperPod cluster that the nodes are moved to. The target cluster must be in the same account and Region as the source cluster, and can be the same cluster as the source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
targetInstanceGroupName
The name of the instance group in the target cluster that the nodes are moved to. If the target cluster is the same as the source cluster, the target instance group must be different from the source instance group.
- Parameters:
targetInstanceGroupName- The name of the instance group in the target cluster that the nodes are moved to. If the target cluster is the same as the source cluster, the target instance group must be different from the source instance group.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
instanceCount
The number of nodes to move, from 1 to 50. HyperPod selects the nodes from the source instance group. If fewer than this number of nodes are eligible to move, the request fails and no nodes are moved. Specify exactly one of
NodeIds,NodeLogicalIds, orInstanceCount.- Parameters:
instanceCount- The number of nodes to move, from 1 to 50. HyperPod selects the nodes from the source instance group. If fewer than this number of nodes are eligible to move, the request fails and no nodes are moved. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeIds
A list of instance IDs of the nodes to move. You can specify up to 50 instance IDs. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one of
NodeIds,NodeLogicalIds, orInstanceCount.- Parameters:
nodeIds- A list of instance IDs of the nodes to move. You can specify up to 50 instance IDs. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeIds
A list of instance IDs of the nodes to move. You can specify up to 50 instance IDs. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one of
NodeIds,NodeLogicalIds, orInstanceCount.- Parameters:
nodeIds- A list of instance IDs of the nodes to move. You can specify up to 50 instance IDs. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeLogicalIds
A list of
NodeLogicalIdsof the nodes to move. You can specify up to 50NodeLogicalIds. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Parameters:
nodeLogicalIds- A list ofNodeLogicalIdsof the nodes to move. You can specify up to 50NodeLogicalIds. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nodeLogicalIds
A list of
NodeLogicalIdsof the nodes to move. You can specify up to 50NodeLogicalIds. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Parameters:
nodeLogicalIds- A list ofNodeLogicalIdsof the nodes to move. You can specify up to 50NodeLogicalIds. Each node is evaluated separately, so some nodes can be moved while others fail. The request fails if moving the eligible nodes would reduce the source instance group below its minimum instance count. Specify exactly one ofNodeIds,NodeLogicalIds, orInstanceCount.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientToken
A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry the request with the same client token and the same parameters within 8 hours, the service returns the original response. It doesn't start a new move. If you reuse a client token with different parameters, the request fails.
- Parameters:
clientToken- A unique, case-sensitive identifier that you provide to ensure that the operation completes no more than one time. If you retry the request with the same client token and the same parameters within 8 hours, the service returns the original response. It doesn't start a new move. If you reuse a client token with different parameters, the request fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
MoveClusterNodesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
MoveClusterNodesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-