Skip to content

DeploymentCircuitBreakerDict

Dictionary Type

DeploymentCircuitBreakerDict

Bases: TypedDict

Dictionary form of DeploymentCircuitBreaker.

Attributes

enable instance-attribute
enable: bool | None

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

reset_on_healthy_task 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 instance-attribute
rollback: bool | None

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 instance-attribute
threshold_configuration: ThresholdConfiguration | ThresholdConfigurationDict | 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.