Skip to content

ECS  >  Structures  >  DeploymentCircuitBreaker

DeploymentCircuitBreaker

Structure Class

DeploymentCircuitBreaker dataclass

Bases: _SerdeShape

Note

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.

Attributes

enable class-attribute instance-attribute
enable: bool = ...

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

reset_on_healthy_task class-attribute instance-attribute
reset_on_healthy_task: bool | None = ...

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.

rollback class-attribute instance-attribute
rollback: bool = ...

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.

threshold_configuration class-attribute instance-attribute
threshold_configuration: ThresholdConfiguration | None = ...

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.