aws-cdk-lib.aws_ecs.CfnService.DeploymentCircuitBreakerProperty

DeploymentCircuitBreakerProperty Struct

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 .

Source

Generated code

Type last changed

v2.262.0 · 22 Jul 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ecs as ecs } from 'aws-cdk-lib';
const deploymentCircuitBreakerProperty: ecs.CfnService.DeploymentCircuitBreakerProperty = {
  enable: false,
  rollback: false,

  // the properties below are optional
  resetOnHealthyTask: false,
  thresholdConfiguration: {
    type: 'type',
    value: 123,
  },
};

Properties

enableboolean | IResolvableenabletyping.Union[bool, IResolvable]enableBooleanEnableboolEnableinterface{}required#

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

resetOnHealthyTask?optionalboolean | IResolvablereset_on_healthy_task?optionaltyping.Union[bool, IResolvable]resetOnHealthyTask?optionalBooleanResetOnHealthyTask?optionalboolResetOnHealthyTask?optionalinterface{}#

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.

rollbackboolean | IResolvablerollbacktyping.Union[bool, IResolvable]rollbackBooleanRollbackboolRollbackinterface{}required#

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.

thresholdConfiguration?optionalIResolvable | CfnService.ThresholdConfigurationPropertythreshold_configuration?optionaltyping.Union[IResolvable, ThresholdConfigurationProperty]thresholdConfiguration?optionalIResolvableThresholdConfiguration?optionalIResolvableThresholdConfiguration?optionalinterface{}#

Defines the failure threshold that the deployment circuit breaker uses to monitor a deployment.

The type and value together determine the number of task failures that are tolerated before the circuit breaker triggers. By default, the threshold configuration uses a type of BOUNDED_PERCENT with a value of 50.