Enum ClusterPatchingStrategy

java.lang.Object
java.lang.Enum<ClusterPatchingStrategy>
software.amazon.awssdk.services.sagemaker.model.ClusterPatchingStrategy
All Implemented Interfaces:
Serializable, Comparable<ClusterPatchingStrategy>
@Generated("software.amazon.awssdk:codegen") public enum ClusterPatchingStrategy extends Enum<ClusterPatchingStrategy>

The strategy for applying automatic patches to instances.

  • WhenIdle: Cordons all instances and patches each instance as it becomes idle (no running jobs). Each instance is uncordoned immediately after patching and becomes available for new jobs. If instances do not become idle, they remain on the previous AMI version. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

  • WhenAllIdle: Cordons all instances and waits for all to become idle before patching. All instances are uncordoned after patching completes. If not all instances become idle, no patching occurs and all instances remain on the previous AMI version.

  • Enum Constant Details

  • Method Details

    • values

      public static ClusterPatchingStrategy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static ClusterPatchingStrategy valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Overrides:
      toString in class Enum<ClusterPatchingStrategy>

    • fromValue

      public static ClusterPatchingStrategy fromValue(String value)
      Use this in place of valueOf to convert the raw string returned by the service into the enum value.
      Parameters:
      value - real value
      Returns:
      ClusterPatchingStrategy corresponding to the value

    • knownValues

      public static Set<ClusterPatchingStrategy> knownValues()
      Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.
      Returns:
      a Set of known ClusterPatchingStrategys