interface DeploymentCircuitBreakerProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.ECS.CfnService.DeploymentCircuitBreakerProperty |
Java | software.amazon.awscdk.services.ecs.CfnService.DeploymentCircuitBreakerProperty |
Python | aws_cdk.aws_ecs.CfnService.DeploymentCircuitBreakerProperty |
TypeScript | @aws-cdk/aws-ecs » CfnService » DeploymentCircuitBreakerProperty |
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 .
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const deploymentCircuitBreakerProperty: ecs.CfnService.DeploymentCircuitBreakerProperty = {
enable: false,
rollback: false,
};
Properties
Name | Type | Description |
---|---|---|
enable | boolean | IResolvable | Determines whether to use the deployment circuit breaker logic for the service. |
rollback | boolean | IResolvable | Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. |
enable
Type:
boolean |
IResolvable
Determines whether to use the deployment circuit breaker logic for the service.
rollback
Type:
boolean |
IResolvable
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.