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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DeploymentCircuitBreaker.Builder

Method Summary

Modifier and Type	Method	Description
static DeploymentCircuitBreaker.Builder	builder()
Boolean	enable()	Determines whether to use the deployment circuit breaker logic for the service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	rollback()	Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DeploymentCircuitBreaker.Builder>	serializableBuilderClass()
DeploymentCircuitBreaker.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

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

Specified by:

toBuilder in interface ToCopyableBuilder<DeploymentCircuitBreaker.Builder,DeploymentCircuitBreaker>

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)

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