interface AlarmMuteRuleOptions

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

Options used to configure a CloudWatch alarm mute rule.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';

declare const scheduleExpression: cloudwatch.ScheduleExpression;
const alarmMuteRuleOptions: cloudwatch.AlarmMuteRuleOptions = {
  duration: cdk.Duration.minutes(30),
  schedule: scheduleExpression,

  // the properties below are optional
  alarmMuteRuleName: 'alarmMuteRuleName',
  description: 'description',
  expire: {
    day: 123,
    hour: 123,
    minute: 123,
    month: 123,
    year: 123,
  },
  start: {
    day: 123,
    hour: 123,
    minute: 123,
    month: 123,
    year: 123,
  },
  tags: {
    tagsKey: 'tags',
  },
};

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

---

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.