interface AlarmMuteRuleProps

Language	Type name
.NET	Amazon.CDK.AWS.CloudWatch.AlarmMuteRuleProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudwatch#AlarmMuteRuleProps
Java	software.amazon.awscdk.services.cloudwatch.AlarmMuteRuleProps
Python	aws_cdk.aws_cloudwatch.AlarmMuteRuleProps
TypeScript (source)	aws-cdk-lib » aws_cloudwatch » AlarmMuteRuleProps

Implements AlarmMuteRuleOptions

Properties used to configure a CloudWatch alarm mute rule.

Example

declare const alarm1: cloudwatch.Alarm;
declare const alarm2: cloudwatch.Alarm;

const alarmMuteRule = new cloudwatch.AlarmMuteRule(this, 'AlarmMuteRule', {
  alarms: [alarm1],
  // Defines the mute period begins at 0:00 everyday in UTC
  schedule: cloudwatch.ScheduleExpression.cron({ minute: '0', hour: '0' }),
  // Specifies the mute rule lasts 1 hour.
  duration: Duration.hours(1),
})

// The mute target can be added after construction.
alarmMuteRule.addAlarm(alarm2);

Properties

Name	Type	Description
duration	Duration	The length of time that alarms remain muted when the schedule activates.
schedule	ScheduleExpression	The schedule defines when alarms should be muted.
alarmMuteRuleName?	string	The name of the alarm mute rule.
alarms?	IAlarmRef[]	The list of alarms that this mute rule targets.
description?	string	A description of the alarm mute rule that helps you identify its purpose.
expire?	CalendarDateTime	The date and time when the mute rule expires and is no longer evaluated.
start?	CalendarDateTime	The date and time after which the mute rule takes effect.
tags?	{ [string]: string }	A list of tags associated with the alarm mute rule.

---

duration

Type: Duration

The length of time that alarms remain muted when the schedule activates.

Minimum: 1 minute, Maximum: 15 days

---

schedule

Type: ScheduleExpression

The schedule defines when alarms should be muted.

---

alarmMuteRuleName?

Type: string (optional, default: generated by CloudFormation)

The name of the alarm mute rule.

This name must be unique within your AWS account and region.

---

alarms?

Type: IAlarmRef[] (optional, default: no target alarms)

The list of alarms that this mute rule targets.

You can specify up to 100 alarms.

---

description?

Type: string (optional, default: no description)

A description of the alarm mute rule that helps you identify its purpose.

---

expire?

Type: CalendarDateTime (optional, default: no configuration)

The date and time when the mute rule expires and is no longer evaluated.

After this time, the rule status becomes EXPIRED and will no longer mute the targeted alarms.

This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.

---

start?

Type: CalendarDateTime (optional, default: no configuration)

The date and time after which the mute rule takes effect.

If not specified, the mute rule takes effect immediately upon creation and the mutes are applied as per the schedule expression.

This date and time is interpreted according to the schedule timezone, or UTC if no timezone is specified.

---

tags?

Type: { [string]: string } (optional, default: No tags are applied)

A list of tags associated with the alarm mute rule.

Tags help you organize and categorize your AWS resources.