# AlarmConfigurationProperty

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

`AlarmConfiguration` is a property of the [DeploymentGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codedeploy-deploymentgroup.html) resource.

- Source: Generated at build time
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

TypeScript:

```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:

```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:

```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();
```

C# / .NET:

```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
};
```

Golang:

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

- `alarms`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDeploymentGroup.AlarmProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_codedeploy.CfnDeploymentGroup.AlarmProperty.html)[] — A list of alarms configured for the deployment or deployment group.

  A maximum of 10 alarms can be added.

- `enabled`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether the alarm configuration is enabled.

- `ignorePollAlarmFailure`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — 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 .
