Class UpdateClusterRequest

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>

  • Method Details

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

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

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateClusterRequest.Builder,UpdateClusterRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.