/AWS1/CL_ECSDEPLOYMENTCIRCUI00

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.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_enable TYPE /AWS1/ECSBOOLEAN /AWS1/ECSBOOLEAN

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

iv_rollback TYPE /AWS1/ECSBOOLEAN /AWS1/ECSBOOLEAN

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.

Optional arguments:

iv_resetonhealthytask TYPE /AWS1/ECSBOXEDBOOLEAN /AWS1/ECSBOXEDBOOLEAN

Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to true, a task that reaches a healthy state resets the failure count to 0. When set to false, Amazon ECS does not reset the failure count. The default is true.

io_thresholdconfiguration TYPE REF TO /AWS1/CL_ECSTHRESHOLDCONF /AWS1/CL_ECSTHRESHOLDCONF

The threshold configuration that controls when the deployment circuit breaker triggers. The type and value together determine how many task failures are tolerated before the circuit breaker activates.

---

Queryable Attributes

enable

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

Accessible with the following methods

Method	Description
GET_ENABLE()	Getter for ENABLE

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.

Accessible with the following methods

Method	Description
GET_ROLLBACK()	Getter for ROLLBACK

resetOnHealthyTask

Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to true, a task that reaches a healthy state resets the failure count to 0. When set to false, Amazon ECS does not reset the failure count. The default is true.

Accessible with the following methods

Method	Description
GET_RESETONHEALTHYTASK()	Getter for RESETONHEALTHYTASK, with configurable default
ASK_RESETONHEALTHYTASK()	Getter for RESETONHEALTHYTASK w/ exceptions if field has no
HAS_RESETONHEALTHYTASK()	Determine if RESETONHEALTHYTASK has a value

thresholdConfiguration

The threshold configuration that controls when the deployment circuit breaker triggers. The type and value together determine how many task failures are tolerated before the circuit breaker activates.

Accessible with the following methods

Method	Description
GET_THRESHOLDCONFIGURATION()	Getter for THRESHOLDCONFIGURATION