# AlarmMuteRuleOptions

Options used to configure a CloudWatch alarm mute rule.

- Source: [`aws-cloudwatch/lib/alarm-mute-rule.ts`](https://github.com/aws/aws-cdk/blob/v2.277.0/packages/aws-cdk-lib/aws-cloudwatch/lib/alarm-mute-rule.ts#L174)
- Type last changed: v2.264.0 · 10 Aug 2026

## Example

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

- `alarmMuteRuleName`: string — The name of the alarm mute rule.

  **Default:** generated by CloudFormation

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

- `description`: string — A description of the alarm mute rule that helps you identify its purpose.

  **Default:** no description

- `duration`: [Duration](/cdk/api/v2/docs/aws-cdk-lib.Duration.html) (required) — The length of time that alarms remain muted when the schedule activates.

  Minimum: 1 minute,
  Maximum: 15 days

- `expire`: [CalendarDateTime](/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.CalendarDateTime.html) — The date and time when the mute rule expires and is no longer evaluated.

  **Default:** no configuration

  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.

- `schedule`: [ScheduleExpression](/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.ScheduleExpression.html) (required) — The schedule defines when alarms should be muted.

- `start`: [CalendarDateTime](/cdk/api/v2/docs/aws-cdk-lib.aws_cloudwatch.CalendarDateTime.html) — The date and time after which the mute rule takes effect.

  **Default:** no configuration

  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`: { [key: string]: string } — A list of tags associated with the alarm mute rule.

  **Default:** No tags are applied

  Tags help you organize and categorize your AWS resources.