Package software.amazon.awssdk.services.ecs.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServiceDeploymentCircuitBreaker.Builder

Method Summary

Modifier and Type	Method	Description
static ServiceDeploymentCircuitBreaker.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	failureCount()	The number of times the circuit breaker detected a service deploymeny failure.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceDeploymentCircuitBreaker.Builder>	serializableBuilderClass()
ServiceDeploymentRollbackMonitorsStatus	status()	The circuit breaker status.
String	statusAsString()	The circuit breaker status.
Integer	threshold()	The threshhold which determines that the service deployment failed.
ServiceDeploymentCircuitBreaker.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ServiceDeploymentRollbackMonitorsStatus

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:

ServiceDeploymentRollbackMonitorsStatus

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

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceDeploymentCircuitBreaker.Builder,ServiceDeploymentCircuitBreaker>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo