Class UpdateClusterSoftwareRequest

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.UpdateClusterSoftwareRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateClusterSoftwareRequest.Builder,UpdateClusterSoftwareRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateClusterSoftwareRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateClusterSoftwareRequest.Builder,UpdateClusterSoftwareRequest>

  • Method Details

    • clusterName

      public final String clusterName()

      Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

      Returns:
      Specify the name or the Amazon Resource Name (ARN) of the SageMaker HyperPod cluster you want to update for security patching.

    • 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<UpdateClusterSoftwareInstanceGroupSpecification> instanceGroups()

      The array of instance groups for which to update AMI versions.

      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:
      The array of instance groups for which to update AMI versions.

    • deploymentConfig

      public final DeploymentConfiguration deploymentConfig()

      The configuration to use when updating the AMI versions.

      Returns:
      The configuration to use when updating the AMI versions.

    • imageId

      public final String imageId()

      When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

      • HyperPodPublicAmiId: Use a HyperPod public AMI

      • CustomAmiId: Use your custom AMI

      • default: Use the default latest system image

      If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

      • Encryption: The custom AMI must be unencrypted.

      • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

      • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

      When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

      Returns:
      When configuring your HyperPod cluster, you can specify an image ID using one of the following options:

      • HyperPodPublicAmiId: Use a HyperPod public AMI

      • CustomAmiId: Use your custom AMI

      • default: Use the default latest system image

      If you choose to use a custom AMI (CustomAmiId), ensure it meets the following requirements:

      • Encryption: The custom AMI must be unencrypted.

      • Ownership: The custom AMI must be owned by the same Amazon Web Services account that is creating the HyperPod cluster.

      • Volume support: Only the primary AMI snapshot volume is supported; additional AMI volumes are not supported.

      When updating the instance group's AMI through the UpdateClusterSoftware operation, if an instance group uses a custom AMI, you must provide an ImageId or use the default as input. Note that if you don't specify an instance group in your UpdateClusterSoftware request, then all of the instance groups are patched with the specified image.

    • toBuilder

      public UpdateClusterSoftwareRequest.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<UpdateClusterSoftwareRequest.Builder,UpdateClusterSoftwareRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateClusterSoftwareRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateClusterSoftwareRequest.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.