Class DeploymentCircuitBreaker

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

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The deployment circuit breaker determines whether a service deployment will fail if the service can't reach a steady state. If it is turned on, a service deployment will transition to a failed state and stop launching new tasks. You can also configure Amazon ECS to roll back your service to the last completed deployment after a failure. For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide.

For more information about API failure reasons, see API failure reasons in the Amazon Elastic Container Service Developer Guide.

See Also:

  • Method Details

    • enable

      public final Boolean enable()

      Determines whether to use the deployment circuit breaker logic for the service.

      Returns:
      Determines whether to use the deployment circuit breaker logic for the service.

    • rollback

      public final Boolean rollback()

      Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

      Returns:
      Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. If rollback is on, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

    • toBuilder

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

    • builder

      public static DeploymentCircuitBreaker.Builder builder()

    • serializableBuilderClass

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