interface DeploymentCircuitBreakerProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.ECS.CfnServicePropsMixin.DeploymentCircuitBreakerProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awsecs#CfnServicePropsMixin_DeploymentCircuitBreakerProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.ecs.CfnServicePropsMixin.DeploymentCircuitBreakerProperty |
 Python | aws_cdk.cfn_property_mixins.aws_ecs.CfnServicePropsMixin.DeploymentCircuitBreakerProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_ecs » CfnServicePropsMixin » 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 .
For more information about API failure reasons, see API failure reasons 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 { aws_ecs as ecs } from '@aws-cdk/cfn-property-mixins';
const deploymentCircuitBreakerProperty: ecs.CfnServicePropsMixin.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
(optional)
Determines whether to use the deployment circuit breaker logic for the service.
rollback?
Type:
boolean | IResolvable
(optional)
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.