feat(codedeploy): ignoreAlarmConfiguration parameter to Deployment Groups

packages/aws-cdk-lib/aws-codedeploy/README.md

@@ -90,6 +90,9 @@ const deploymentGroup = new codedeploy.ServerDeploymentGroup(this, 'CodeDeployDe
   // whether to ignore failure to fetch the status of alarms from CloudWatch
   // default: false
   ignorePollAlarmsFailure: false,
+  // whether to skip the step of checking CloudWatch alarms during the deployment process
+  // default: false
+  ignoreAlarmConfiguration: false,
   // auto-rollback configuration
   autoRollback: {
     failedDeployment: true, // default: true

packages/aws-cdk-lib/aws-codedeploy/lib/ecs/deployment-group.ts

@@ -178,6 +178,13 @@ export interface EcsDeploymentGroupProps {
    * @default - default AutoRollbackConfig.
    */
   readonly autoRollback?: AutoRollbackConfig;
+
+  /**
+   * Whether to skip the step of checking CloudWatch alarms during the deployment process
+   *
+   * @default false
+   */
+  readonly ignoreAlarmConfiguration?: boolean;
 }
 
 /**
@@ -261,7 +268,12 @@ export class EcsDeploymentGroup extends DeploymentGroupBase implements IEcsDeplo
       }),
       loadBalancerInfo: cdk.Lazy.any({ produce: () => this.renderLoadBalancerInfo(props.blueGreenDeploymentConfig) }),
       alarmConfiguration: cdk.Lazy.any({
-        produce: () => renderAlarmConfiguration(this.alarms, props.ignorePollAlarmsFailure, removeAlarmsFromDeploymentGroup),
+        produce: () => renderAlarmConfiguration(
+          this.alarms,
+          props.ignorePollAlarmsFailure,
+          removeAlarmsFromDeploymentGroup,
+          props.ignoreAlarmConfiguration,
+        ),
       }),
       autoRollbackConfiguration: cdk.Lazy.any({ produce: () => renderAutoRollbackConfiguration(this.alarms, props.autoRollback) }),
     });

packages/aws-cdk-lib/aws-codedeploy/lib/lambda/deployment-group.ts

@@ -117,6 +117,13 @@ export interface LambdaDeploymentGroupProps {
    * @default - default AutoRollbackConfig.
    */
   readonly autoRollback?: AutoRollbackConfig;
+
+  /**
+   * Whether to skip the step of checking CloudWatch alarms during the deployment process
+   *
+   * @default false
+   */
+  readonly ignoreAlarmConfiguration?: boolean;
 }
 
 /**
@@ -177,7 +184,11 @@ export class LambdaDeploymentGroup extends DeploymentGroupBase implements ILambd
         deploymentOption: 'WITH_TRAFFIC_CONTROL',
       },
       alarmConfiguration: cdk.Lazy.any({
-        produce: () => renderAlarmConfiguration(this.alarms, props.ignorePollAlarmsFailure, removeAlarmsFromDeploymentGroup),
+        produce: () => renderAlarmConfiguration(
+          this.alarms, props.ignorePollAlarmsFailure,
+          removeAlarmsFromDeploymentGroup,
+          props.ignoreAlarmConfiguration,
+        ),
       }),
       autoRollbackConfiguration: cdk.Lazy.any({ produce: () => renderAutoRollbackConfiguration(this.alarms, props.autoRollback) }),
     });

packages/aws-cdk-lib/aws-codedeploy/lib/private/utils.ts

@@ -31,12 +31,16 @@ export function arnForDeploymentConfig(name: string, resource?: IResource): stri
   });
 }
 
-export function renderAlarmConfiguration(alarms: cloudwatch.IAlarm[], ignorePollAlarmFailure: boolean | undefined, removeAlarms = true):
-CfnDeploymentGroup.AlarmConfigurationProperty | undefined {
+export function renderAlarmConfiguration(
+  alarms: cloudwatch.IAlarm[],
+  ignorePollAlarmFailure: boolean | undefined,
+  removeAlarms = true,
+  ignoreAlarmConfiguration: boolean = false,
+): CfnDeploymentGroup.AlarmConfigurationProperty | undefined {
   if (removeAlarms) {
     return {
       alarms: alarms.length > 0 ? alarms.map(a => ({ name: a.alarmName })) : undefined,
-      enabled: alarms.length > 0,
+      enabled: !ignoreAlarmConfiguration && alarms.length > 0,
       ignorePollAlarmFailure,
     };
   }
@@ -45,7 +49,7 @@ CfnDeploymentGroup.AlarmConfigurationProperty | undefined {
     ? undefined
     : {
       alarms: alarms.map(a => ({ name: a.alarmName })),
-      enabled: true,
+      enabled: !ignoreAlarmConfiguration,
       ignorePollAlarmFailure,
     };
 }

packages/aws-cdk-lib/aws-codedeploy/lib/server/deployment-group.ts

@@ -210,6 +210,13 @@ export interface ServerDeploymentGroupProps {
    * @default - default AutoRollbackConfig.
    */
   readonly autoRollback?: AutoRollbackConfig;
+
+  /**
+   * Whether to skip the step of checking CloudWatch alarms during the deployment process
+   *
+   * @default false
+   */
+  readonly ignoreAlarmConfiguration?: boolean;
 }
 
 /**
@@ -286,7 +293,11 @@ export class ServerDeploymentGroup extends DeploymentGroupBase implements IServe
       ec2TagSet: this.ec2TagSet(props.ec2InstanceTags),
       onPremisesTagSet: this.onPremiseTagSet(props.onPremiseInstanceTags),
       alarmConfiguration: cdk.Lazy.any({
-        produce: () => renderAlarmConfiguration(this.alarms, props.ignorePollAlarmsFailure, removeAlarmsFromDeploymentGroup),
+        produce: () => renderAlarmConfiguration(
+          this.alarms, props.ignorePollAlarmsFailure,
+          removeAlarmsFromDeploymentGroup,
+          props.ignoreAlarmConfiguration,
+        ),
       }),
       autoRollbackConfiguration: cdk.Lazy.any({ produce: () => renderAutoRollbackConfiguration(this.alarms, props.autoRollback) }),
     });

packages/aws-cdk-lib/aws-codedeploy/test/ecs/deployment-group.test.ts

@@ -884,4 +884,33 @@ describe('CodeDeploy ECS DeploymentGroup', () => {
       ));
     });
   });
+
+  test('can ignore alarm status when alarms are present', () => {
+    const stack = new cdk.Stack();
+    new codedeploy.EcsDeploymentGroup(stack, 'MyDG', {
+      ignoreAlarmConfiguration: true,
+      alarms: [
+        new cloudwatch.Alarm(stack, 'BlueTGUnHealthyHosts', {
+          metric: new cloudwatch.Metric({
+            namespace: 'AWS/ApplicationELB',
+            metricName: 'UnHealthyHostCount',
+          }),
+          threshold: 1,
+          evaluationPeriods: 1,
+        }),
+      ],
+      service: mockEcsService(stack),
+      blueGreenDeploymentConfig: {
+        blueTargetGroup: mockTargetGroup(stack, 'blue'),
+        greenTargetGroup: mockTargetGroup(stack, 'green'),
+        listener: mockListener(stack, 'prod'),
+      },
+    });
+
+    Template.fromStack(stack).hasResourceProperties('AWS::CodeDeploy::DeploymentGroup', {
+      AlarmConfiguration: {
+        Enabled: false,
+      },
+    });
+  });
 });

packages/aws-cdk-lib/aws-codedeploy/test/lambda/deployment-group.test.ts

@@ -652,6 +652,31 @@ describe('CodeDeploy Lambda DeploymentGroup', () => {
       ));
     });
   });
+
+  test('can ignore alarm status when alarms are present', () => {
+    const stack = new cdk.Stack();
+    const application = new codedeploy.LambdaApplication(stack, 'MyApp');
+    const alias = mockAlias(stack);
+    new codedeploy.LambdaDeploymentGroup(stack, 'MyDG', {
+      application,
+      alias,
+      postHook: mockFunction(stack, 'PostHook'),
+      deploymentConfig: codedeploy.LambdaDeploymentConfig.ALL_AT_ONCE,
+      ignoreAlarmConfiguration: true,
+      alarms: [new cloudwatch.Alarm(stack, 'Failures', {
+        metric: alias.metricErrors(),
+        comparisonOperator: cloudwatch.ComparisonOperator.GREATER_THAN_THRESHOLD,
+        threshold: 1,
+        evaluationPeriods: 1,
+      })],
+    });
+
+    Template.fromStack(stack).hasResourceProperties('AWS::CodeDeploy::DeploymentGroup', {
+      AlarmConfiguration: {
+        Enabled: false,
+      },
+    });
+  });
 });
 
 describe('imported with fromLambdaDeploymentGroupAttributes', () => {

packages/aws-cdk-lib/aws-codedeploy/test/server/deployment-group.test.ts

@@ -540,4 +540,28 @@ describe('CodeDeploy Server Deployment Group', () => {
       ));
     });
   });
+
+  test('can ignore alarm status when alarms are present', () => {
+    const stack = new cdk.Stack();
+
+    new codedeploy.ServerDeploymentGroup(stack, 'DeploymentGroup', {
+      alarms: [
+        new cloudwatch.Alarm(stack, 'Alarm1', {
+          metric: new cloudwatch.Metric({
+            metricName: 'Errors',
+            namespace: 'my.namespace',
+          }),
+          threshold: 1,
+          evaluationPeriods: 1,
+        }),
+      ],
+      ignoreAlarmConfiguration: true,
+    });
+
+    Template.fromStack(stack).hasResourceProperties('AWS::CodeDeploy::DeploymentGroup', {
+      AlarmConfiguration: {
+        Enabled: false,
+      },
+    });
+  });
 });