AWS cdk: Document cdk deploy rollback trigger alarm options
Summary
Adds reference documentation for the --monitoring-time-minutes and --rollback-trigger-alarm-arns options, which configure CloudWatch alarms that trigger CloudFormation rollback during and after deployment.
Security assessment
The options configure deployment rollback safety via CloudWatch alarms, which is operational/availability hardening rather than a security control; no vulnerability, credential, or access-control content is present.
Evidence
+The ARNs of the CloudWatch alarms that CloudFormation monitors during the deployment. If any of these alarms goes to the `ALARM` state, CloudFormation rolls back the deployment. You can specify a maximum of 5 alarms. The alarms are treated as metric alarms (`AWS::CloudWatch::Alarm`).
Diff
diff --git a/cdk/v2/guide/ref-cli-cmd-deploy.md b/cdk/v2/guide/ref-cli-cmd-deploy.md index 40af0e5..39fb913 100644 --- a//cdk/v2/guide/ref-cli-cmd-deploy.md +++ b//cdk/v2/guide/ref-cli-cmd-deploy.md @@ -258,0 +259,9 @@ _Default value_ : `change-set` +`--monitoring-time-minutes <NUMBER>` + + +The number of minutes that CloudFormation continues to monitor the rollback trigger alarms after the deployment completes, before cleaning up old resources. The value must be a whole number between 0 and 180. + +You must use this option together with ` --rollback-trigger-alarm-arns `. + +_Default value_ : `0` (CloudFormation monitors the alarms only while the deployment is in progress) + @@ -377,0 +387,11 @@ _Default value_ : `--rollback` +`--rollback-trigger-alarm-arns <ARRAY>` + + +The ARNs of the CloudWatch alarms that CloudFormation monitors during the deployment. If any of these alarms goes to the `ALARM` state, CloudFormation rolls back the deployment. You can specify a maximum of 5 alarms. The alarms are treated as metric alarms (`AWS::CloudWatch::Alarm`). + +This option can be specified multiple times in a single command. + +To clear any rollback triggers that were previously configured on the stack, pass the single value `none`. + +To control how long CloudFormation continues to monitor these alarms after the deployment completes, use ` --monitoring-time-minutes `. +