Class UpdatePolicy

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

Specifies the infrastructure update policy for the Amazon EC2 compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

See Also:

  • Method Details

    • terminateJobsOnUpdate

      public final Boolean terminateJobsOnUpdate()

      Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. The default value is false.

      Returns:
      Specifies whether jobs are automatically terminated when the compute environment infrastructure is updated. The default value is false.

    • jobExecutionTimeoutMinutes

      public final Long jobExecutionTimeoutMinutes()

      Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30. The maximum value is 7200.

      Increasing jobExecutionTimeoutMinutes during infrastructure updates delays the replacement of instances with new instances that include updates such as security patches, but provides more time for jobs to execute. Consider the security implications of this tradeoff when setting timeout values.

      Returns:
      Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30. The maximum value is 7200.

      Increasing jobExecutionTimeoutMinutes during infrastructure updates delays the replacement of instances with new instances that include updates such as security patches, but provides more time for jobs to execute. Consider the security implications of this tradeoff when setting timeout values.

    • toBuilder

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

    • builder

      public static UpdatePolicy.Builder builder()

    • serializableBuilderClass

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