Skip to content

DeploymentCircuitBreaker

Source code in docs_src/capo_ecs/types/deployment_circuit_breaker.py 
13
14
15
16
17
18
19
20
21
22
23
class DeploymentCircuitBreaker(TypedDict, closed=True):
    enable: "capo_ecs.types.boolean.Boolean"
    """<p>Determines whether to use the deployment circuit breaker logic for the service.</p>"""
    rollback: "capo_ecs.types.boolean.Boolean"
    """<p>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.</p>"""
    reset_on_healthy_task: NotRequired["capo_ecs.types.boxed_boolean.BoxedBoolean"]
    """<p>Specifies whether the deployment circuit breaker resets its failure count when a task reaches a healthy state. When set to <code>true</code>, a task that reaches a healthy state resets the failure count to <code>0</code>. When set to <code>false</code>, Amazon ECS does not reset the failure count. The default is <code>true</code>.</p>"""
    threshold_configuration: NotRequired[
        "capo_ecs.types.threshold_configuration.ThresholdConfiguration"
    ]
    """<p>The threshold configuration that controls when the deployment circuit breaker triggers. The <code>type</code> and <code>value</code> together determine how many task failures are tolerated before the circuit breaker activates.</p>"""

enable instance-attribute 

enable: Boolean

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

reset_on_healthy_task instance-attribute 

reset_on_healthy_task: NotRequired[BoxedBoolean]

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: Boolean

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: NotRequired[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.