java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.sagemaker.model.SageMakerRequest
    - - software.amazon.awssdk.services.sagemaker.model.UpdateClusterRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateClusterRequest
extends SageMakerRequest
implements ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateClusterRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ClusterAutoScalingConfig`	`autoScaling()`	Updates the autoscaling configuration for the cluster.
`static UpdateClusterRequest.Builder`	`builder()`
`String`	`clusterName()`	Specify the name of the SageMaker HyperPod cluster you want to update.
`String`	`clusterRole()`	The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInstanceGroups()`	For responses, this returns true if the service returned a value for the InstanceGroups property.
`boolean`	`hasInstanceGroupsToDelete()`	For responses, this returns true if the service returned a value for the InstanceGroupsToDelete property.
`boolean`	`hasRestrictedInstanceGroups()`	For responses, this returns true if the service returned a value for the RestrictedInstanceGroups property.
`List<ClusterInstanceGroupSpecification>`	`instanceGroups()`	Specify the instance groups to update.
`List<String>`	`instanceGroupsToDelete()`	Specify the names of the instance groups to delete.
`ClusterNodeRecovery`	`nodeRecovery()`	The node recovery mode to be applied to the SageMaker HyperPod cluster.
`String`	`nodeRecoveryAsString()`	The node recovery mode to be applied to the SageMaker HyperPod cluster.
`List<ClusterRestrictedInstanceGroupSpecification>`	`restrictedInstanceGroups()`	The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdateClusterRequest.Builder>`	`serializableBuilderClass()`
`ClusterTieredStorageConfig`	`tieredStorageConfig()`	Updates the configuration for managed tier checkpointing on the HyperPod cluster.
`UpdateClusterRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clusterName
```
public final String clusterName()
```
    Specify the name of the SageMaker HyperPod cluster you want to update.
    
    Returns:
    
    Specify the name of the SageMaker HyperPod cluster you want to update.
  - hasInstanceGroups
```
public final boolean hasInstanceGroups()
```
    For responses, this returns true if the service returned a value for the InstanceGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - instanceGroups
```
public final List<ClusterInstanceGroupSpecification> instanceGroups()
```
    Specify the instance groups to update.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceGroups() method.
    
    Returns:
    
    Specify the instance groups to update.
  - hasRestrictedInstanceGroups
```
public final boolean hasRestrictedInstanceGroups()
```
    For responses, this returns true if the service returned a value for the RestrictedInstanceGroups property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - restrictedInstanceGroups
```
public final List<ClusterRestrictedInstanceGroupSpecification> restrictedInstanceGroups()
```
    The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRestrictedInstanceGroups() method.
    
    Returns:
    
    The specialized instance groups for training models like Amazon Nova to be created in the SageMaker HyperPod cluster.
  - tieredStorageConfig
```
public final ClusterTieredStorageConfig tieredStorageConfig()
```
    Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.
    
    Returns:
    
    Updates the configuration for managed tier checkpointing on the HyperPod cluster. For example, you can enable or disable the feature and modify the percentage of cluster memory allocated for checkpoint storage.
  - nodeRecovery
```
public final ClusterNodeRecovery nodeRecovery()
```
    The node recovery mode to be applied to the SageMaker HyperPod cluster.
    
    If the service returns an enum value that is not available in the current SDK version, nodeRecovery will return ClusterNodeRecovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nodeRecoveryAsString().
    
    Returns:
    
    The node recovery mode to be applied to the SageMaker HyperPod cluster.
    
    See Also:
    
    ClusterNodeRecovery
  - nodeRecoveryAsString
```
public final String nodeRecoveryAsString()
```
    The node recovery mode to be applied to the SageMaker HyperPod cluster.
    
    If the service returns an enum value that is not available in the current SDK version, nodeRecovery will return ClusterNodeRecovery.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from nodeRecoveryAsString().
    
    Returns:
    
    The node recovery mode to be applied to the SageMaker HyperPod cluster.
    
    See Also:
    
    ClusterNodeRecovery
  - hasInstanceGroupsToDelete
```
public final boolean hasInstanceGroupsToDelete()
```
    For responses, this returns true if the service returned a value for the InstanceGroupsToDelete property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - instanceGroupsToDelete
```
public final List<String> instanceGroupsToDelete()
```
    Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceGroupsToDelete() method.
    
    Returns:
    
    Specify the names of the instance groups to delete. Use a single , as the separator between multiple names.
  - clusterRole
```
public final String clusterRole()
```
    The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IAM role that HyperPod assumes for cluster autoscaling operations. Cannot be updated while autoscaling is enabled.
  - autoScaling
```
public final ClusterAutoScalingConfig autoScaling()
```
    Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.
    
    Returns:
    
    Updates the autoscaling configuration for the cluster. Use to enable or disable automatic node scaling.
  - toBuilder
```
public UpdateClusterRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static UpdateClusterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateClusterRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateClusterRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clusterName

hasInstanceGroups

instanceGroups

hasRestrictedInstanceGroups

restrictedInstanceGroups

tieredStorageConfig

nodeRecovery

nodeRecoveryAsString

hasInstanceGroupsToDelete

instanceGroupsToDelete

clusterRole

autoScaling

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField