Skip to content
v2.277.0

AlarmConfigurationProperty Struct ​

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

AlarmConfiguration is a property of the DeploymentGroup resource.

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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_codedeploy as codedeploy

alarm_configuration_property = codedeploy.CfnDeploymentGroup.AlarmConfigurationProperty(
    alarms=[codedeploy.CfnDeploymentGroup.AlarmProperty(
        name="name"
    )],
    enabled=False,
    ignore_poll_alarm_failure=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.codedeploy.*;

AlarmConfigurationProperty alarmConfigurationProperty = AlarmConfigurationProperty.builder()
        .alarms(List.of(AlarmProperty.builder()
                .name("name")
                .build()))
        .enabled(false)
        .ignorePollAlarmFailure(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodeDeploy;

var alarmConfigurationProperty = new AlarmConfigurationProperty {
    Alarms = new [] { new AlarmProperty {
        Name = "name"
    } },
    Enabled = false,
    IgnorePollAlarmFailure = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

alarmConfigurationProperty := &AlarmConfigurationProperty{
	Alarms: []interface{}{
		&AlarmProperty{
			Name: jsii.String("name"),
		},
	},
	Enabled: jsii.Boolean(false),
	IgnorePollAlarmFailure: jsii.Boolean(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 .