Skip to content

ECS  >  Structures  >  DeploymentAlarms

DeploymentAlarms

Structure Class

DeploymentAlarms dataclass

Bases: _SerdeShape

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.

For more information, see Rolling update in the Amazon Elastic Container Service Developer Guide .

Attributes

alarm_names instance-attribute
alarm_names: list[str]

One or more CloudWatch alarm names. Use a "," to separate the alarms.

enable class-attribute instance-attribute
enable: bool = ...

Determines whether to use the CloudWatch alarm option in the service deployment process.

rollback class-attribute instance-attribute
rollback: bool = ...

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.