AWS CDK Reference

Appearance

v2.275.0

AlarmConfigurationProperty Struct ​

The AlarmConfiguration property type configures CloudWatch alarms for an AWS CodeDeploy deployment group.

AlarmConfiguration is a property of the DeploymentGroup resource.

Source
Generated code
Type last changed
v2.93.0 · 23 Aug 2023

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_codedeploy as codedeploy } from 'aws-cdk-lib';
const alarmConfigurationProperty: codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty = {
  alarms: [{
    name: 'name',
  }],
  enabled: false,
  ignorePollAlarmFailure: false,
};

Properties ​

alarmsoptionalIResolvable | IResolvable | CfnDeploymentGroup.AlarmProperty[]alarmsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, AlarmProperty]]]alarmsoptionalIResolvableAlarmsoptionalIResolvableAlarmsoptionalinterface{}#
A list of alarms configured for the deployment or deployment group.

A maximum of 10 alarms can be added.

enabledoptionalboolean | IResolvableenabledoptionaltyping.Union[bool, IResolvable]enabledoptionalBooleanEnabledoptionalboolEnabledoptionalinterface{}#
Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailureoptionalboolean | IResolvableignore_poll_alarm_failureoptionaltyping.Union[bool, IResolvable]ignorePollAlarmFailureoptionalBooleanIgnorePollAlarmFailureoptionalboolIgnorePollAlarmFailureoptionalinterface{}#
Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch .

The default value is false .

  • true : The deployment proceeds even if alarm status information can't be retrieved from CloudWatch .
  • false : The deployment stops if alarm status information can't be retrieved from CloudWatch .