AWS::ECS::Service DeploymentCircuitBreaker

Note

The deployment circuit breaker can only be used for services using the rolling update (ECS) deployment type.

The DeploymentCircuitBreaker property determines whether a service deployment will fail if the service can't reach a steady state. If deployment circuit breaker is enabled, a service deployment will transition to a failed state and stop launching new tasks. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Enable" : Boolean,
  "Rollback" : Boolean
}

YAML

  Enable: Boolean
  Rollback: Boolean

Properties

Enable

Whether to enable the deployment circuit breaker logic for the service.

Required: Yes

Type: Boolean

Update requires: No interruption

Rollback

Whether to enable Amazon ECS to roll back the service if a service deployment fails. If rollback is enabled, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.

Required: Yes

Type: Boolean

Update requires: No interruption