Class ClusterDrainPolicy

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.ClusterDrainPolicy
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ClusterDrainPolicy.Builder,ClusterDrainPolicy>
@Generated("software.amazon.awssdk:codegen") public final class ClusterDrainPolicy extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ClusterDrainPolicy.Builder,ClusterDrainPolicy>

Specifies how pods are evicted from an instance before it is patched with the DrainFirst strategy. By default, evictions respect Kubernetes Pod Disruption Budgets.

See Also:

  • Method Details

    • drainTimeoutInSeconds

      public final Integer drainTimeoutInSeconds()

      The maximum time, in seconds, to wait for the pods on an instance to drain. Valid values are from 0 to 5400 (90 minutes). The default is 3600 (1 hour).

      Returns:
      The maximum time, in seconds, to wait for the pods on an instance to drain. Valid values are from 0 to 5400 (90 minutes). The default is 3600 (1 hour).

    • onDrainTimeout

      public final ClusterOnDrainTimeout onDrainTimeout()

      The action to take if the pods on an instance don't drain within DrainTimeoutInSeconds. The default is Skip.

      • Skip: Doesn't patch the instance. The instance is uncordoned and remains on the previous AMI version. This can leave the instance group partially patched. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

      • Force: Deletes the remaining pods without respecting Pod Disruption Budgets, and then patches the instance.

      If the service returns an enum value that is not available in the current SDK version, onDrainTimeout will return ClusterOnDrainTimeout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onDrainTimeoutAsString().

      Returns:
      The action to take if the pods on an instance don't drain within DrainTimeoutInSeconds. The default is Skip.

      • Skip: Doesn't patch the instance. The instance is uncordoned and remains on the previous AMI version. This can leave the instance group partially patched. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

      • Force: Deletes the remaining pods without respecting Pod Disruption Budgets, and then patches the instance.

      See Also:

    • onDrainTimeoutAsString

      public final String onDrainTimeoutAsString()

      The action to take if the pods on an instance don't drain within DrainTimeoutInSeconds. The default is Skip.

      • Skip: Doesn't patch the instance. The instance is uncordoned and remains on the previous AMI version. This can leave the instance group partially patched. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

      • Force: Deletes the remaining pods without respecting Pod Disruption Budgets, and then patches the instance.

      If the service returns an enum value that is not available in the current SDK version, onDrainTimeout will return ClusterOnDrainTimeout.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from onDrainTimeoutAsString().

      Returns:
      The action to take if the pods on an instance don't drain within DrainTimeoutInSeconds. The default is Skip.

      • Skip: Doesn't patch the instance. The instance is uncordoned and remains on the previous AMI version. This can leave the instance group partially patched. You can then use UpdateClusterSoftware with the desired ImageReleaseVersion to manually update the remaining instances.

      • Force: Deletes the remaining pods without respecting Pod Disruption Budgets, and then patches the instance.

      See Also:

    • toBuilder

      public ClusterDrainPolicy.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<ClusterDrainPolicy.Builder,ClusterDrainPolicy>
      Returns:
      a builder for type T

    • builder

      public static ClusterDrainPolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ClusterDrainPolicy.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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