interface DeploymentAlarmsProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.ECS.CfnService.DeploymentAlarmsProperty |
 Java | software.amazon.awscdk.services.ecs.CfnService.DeploymentAlarmsProperty |
 Python | aws_cdk.aws_ecs.CfnService.DeploymentAlarmsProperty |
 TypeScript | @aws-cdk/aws-ecs » CfnService » DeploymentAlarmsProperty |
One of the methods which provide a way for you to quickly identify when a deployment has failed, and then to optionally roll back the failure to the last working deployment.
When the alarms are generated, Amazon ECS sets the service deployment to failed. Set the rollback parameter to have Amazon ECS to roll back your service to the last completed deployment after a failure.
You can only use the DeploymentAlarms method to detect failures when the DeploymentController is set to ECS (rolling update).
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 deploymentAlarmsProperty: ecs.CfnService.DeploymentAlarmsProperty = {
alarmNames: ['alarmNames'],
enable: false,
rollback: false,
};
Properties
| Name | Type | Description |
|---|---|---|
| alarm | string[] | One or more CloudWatch alarm names. |
| enable | boolean | IResolvable | Determines whether to use the CloudWatch alarm option in the service deployment process. |
| rollback | boolean | IResolvable | Determines whether to configure Amazon ECS to roll back the service if a service deployment fails. |
alarmNames
Type:
string[]
One or more CloudWatch alarm names.
Use a "," to separate the alarms.
enable
Type:
boolean | IResolvable
Determines whether to use the CloudWatch alarm option in the service deployment process.
rollback
Type:
boolean | IResolvable
Determines whether to configure Amazon ECS to roll back the service if a service deployment fails.
If rollback is used, when a service deployment fails, the service is rolled back to the last deployment that completed successfully.