interface AlarmConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.CodeDeploy.CfnDeploymentGroup.AlarmConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscodedeploy#CfnDeploymentGroup_AlarmConfigurationProperty`
Java	`software.amazon.awscdk.services.codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty`
Python	`aws_cdk.aws_codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_codedeploy` » `CfnDeploymentGroup` » `AlarmConfigurationProperty`

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

AlarmConfiguration is a property of the DeploymentGroup resource.

Example

// 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

Name	Type	Description
alarms?	`IResolvable` `\| (IResolvable` `\|` `AlarmProperty)[]`	A list of alarms configured for the deployment or deployment group.
enabled?	`boolean \|` `IResolvable`	Indicates whether the alarm configuration is enabled.
ignorePollAlarmFailure?	`boolean \|` `IResolvable`	Indicates whether a deployment should continue if information about the current state of alarms cannot be retrieved from Amazon CloudWatch .

alarms?

Type: IResolvable | (IResolvable | AlarmProperty)[] (optional)

A list of alarms configured for the deployment or deployment group.

A maximum of 10 alarms can be added.

enabled?

Type: boolean | IResolvable (optional)

Indicates whether the alarm configuration is enabled.

ignorePollAlarmFailure?

Type: boolean | IResolvable (optional)

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 .