Package software.amazon.awscdk.services.cloudwatch

Interface AlarmMuteRuleOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AlarmMuteRuleProps

All Known Implementing Classes:

AlarmMuteRuleOptions.Jsii$Proxy, AlarmMuteRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.138.0 (build 0ca7ee8)",
           date="2026-08-10T14:50:59.308Z")
@Stability(Stable)
public interface AlarmMuteRuleOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cloudwatch.*;
 ScheduleExpression scheduleExpression;
 AlarmMuteRuleOptions alarmMuteRuleOptions = AlarmMuteRuleOptions.builder()
         .duration(Duration.minutes(30))
         .schedule(scheduleExpression)
         // the properties below are optional
         .alarmMuteRuleName("alarmMuteRuleName")
         .description("description")
         .expire(CalendarDateTime.builder()
                 .day(123)
                 .hour(123)
                 .minute(123)
                 .month(123)
                 .year(123)
                 .build())
         .start(CalendarDateTime.builder()
                 .day(123)
                 .hour(123)
                 .minute(123)
                 .month(123)
                 .year(123)
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AlarmMuteRuleOptions.Builder	A builder for AlarmMuteRuleOptions
static final class	AlarmMuteRuleOptions.Jsii$Proxy	An implementation for AlarmMuteRuleOptions

Method Summary

Modifier and Type	Method	Description
static AlarmMuteRuleOptions.Builder	builder()
default String	getAlarmMuteRuleName()	The name of the alarm mute rule.
default String	getDescription()	A description of the alarm mute rule that helps you identify its purpose.
Duration	getDuration()	The length of time that alarms remain muted when the schedule activates.
default CalendarDateTime	getExpire()	The date and time when the mute rule expires and is no longer evaluated.
ScheduleExpression	getSchedule()	The schedule defines when alarms should be muted.
default CalendarDateTime	getStart()	The date and time after which the mute rule takes effect.
default Map<String,String>	getTags()	A list of tags associated with the alarm mute rule.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDuration

@Stability(Stable)
@NotNull
Duration getDuration()

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

Minimum: 1 minute, Maximum: 15 days

getSchedule

@Stability(Stable)
@NotNull
ScheduleExpression getSchedule()

The schedule defines when alarms should be muted.

getAlarmMuteRuleName

@Stability(Stable)
@Nullable
default String getAlarmMuteRuleName()

The name of the alarm mute rule.

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

Default: - generated by CloudFormation

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

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

Default: - no description

getExpire

@Stability(Stable)
@Nullable
default CalendarDateTime getExpire()

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.

Default: - no configuration

getStart

@Stability(Stable)
@Nullable
default CalendarDateTime getStart()

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.

Default: - no configuration

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

A list of tags associated with the alarm mute rule.

Tags help you organize and categorize your AWS resources.

Default: - No tags are applied

builder

@Stability(Stable)
static AlarmMuteRuleOptions.Builder builder()

Returns:

a AlarmMuteRuleOptions.Builder of AlarmMuteRuleOptions