com.amazonaws.services.ecs.model

Class DeploymentCircuitBreaker

java.lang.Object

com.amazonaws.services.ecs.model.DeploymentCircuitBreaker

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DeploymentCircuitBreaker
extends Object
implements Serializable, Cloneable, StructuredPojo

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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeploymentCircuitBreaker()

Method Summary

Modifier and Type	Method and Description
DeploymentCircuitBreaker	clone()
boolean	equals(Object obj)
Boolean	getEnable() Determines whether to use the deployment circuit breaker logic for the service.
Boolean	getRollback() Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
int	hashCode()
Boolean	isEnable() Determines whether to use the deployment circuit breaker logic for the service.
Boolean	isRollback() Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEnable(Boolean enable) Determines whether to use the deployment circuit breaker logic for the service.
void	setRollback(Boolean rollback) Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
String	toString() Returns a string representation of this object.
DeploymentCircuitBreaker	withEnable(Boolean enable) Determines whether to use the deployment circuit breaker logic for the service.
DeploymentCircuitBreaker	withRollback(Boolean rollback) Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeploymentCircuitBreaker

public DeploymentCircuitBreaker()

Method Detail

setEnable

public void setEnable(Boolean enable)

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

Parameters:

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

getEnable

public Boolean getEnable()

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.

withEnable

public DeploymentCircuitBreaker withEnable(Boolean enable)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnable

public Boolean isEnable()

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.

setRollback

public void setRollback(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.

Parameters:

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.

getRollback

public Boolean getRollback()

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.

withRollback

public DeploymentCircuitBreaker withRollback(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

isRollback

public Boolean isRollback()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DeploymentCircuitBreaker clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.