Class ServiceDeploymentCircuitBreaker

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

Information about the circuit breaker used to determine when a service deployment has failed.

The deployment circuit breaker is the rolling update mechanism that determines if the tasks reach a steady state. The deployment circuit breaker has an option that will automatically roll back a failed deployment to the last cpompleted service revision. For more information, see How the Amazon ECS deployment circuit breaker detects failures in the Amazon ECS Developer Guide.

See Also:

  • Method Details

    • status

      public final ServiceDeploymentRollbackMonitorsStatus status()

      The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.

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

      Returns:
      The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.

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

      Returns:
      The circuit breaker status. Amazon ECS is not using the circuit breaker for service deployment failures when the status is DISABLED.
      See Also:

    • failureCount

      public final Integer failureCount()

      The number of times the circuit breaker detected a service deploymeny failure.

      Returns:
      The number of times the circuit breaker detected a service deploymeny failure.

    • threshold

      public final Integer threshold()

      The threshhold which determines that the service deployment failed.

      The deployment circuit breaker calculates the threshold value, and then uses the value to determine when to move the deployment to a FAILED state. The deployment circuit breaker has a minimum threshold of 3 and a maximum threshold of 200. and uses the values in the following formula to determine the deployment failure.

      0.5 * desired task count

      Returns:
      The threshhold which determines that the service deployment failed.

      The deployment circuit breaker calculates the threshold value, and then uses the value to determine when to move the deployment to a FAILED state. The deployment circuit breaker has a minimum threshold of 3 and a maximum threshold of 200. and uses the values in the following formula to determine the deployment failure.

      0.5 * desired task count

    • toBuilder

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

    • builder

      public static ServiceDeploymentCircuitBreaker.Builder builder()

    • serializableBuilderClass

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