Package software.amazon.awscdk.services.cloudwatch

Interface AlarmMuteRuleProps

All Superinterfaces:

AlarmMuteRuleOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AlarmMuteRuleProps.Jsii$Proxy

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

Properties used to configure a CloudWatch alarm mute rule.

Example:

 Alarm alarm1;
 Alarm alarm2;
 AlarmMuteRule alarmMuteRule = AlarmMuteRule.Builder.create(this, "AlarmMuteRule")
         .alarms(List.of(alarm1))
         // Defines the mute period begins at 0:00 everyday in UTC
         .schedule(ScheduleExpression.cron(CronOptions.builder().minute("0").hour("0").build()))
         // Specifies the mute rule lasts 1 hour.
         .duration(Duration.hours(1))
         .build();
 // The mute target can be added after construction.
 alarmMuteRule.addAlarm(alarm2);
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AlarmMuteRuleProps.Builder	builder()
default List<IAlarmRef>	getAlarms()	The list of alarms that this mute rule targets.

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.AlarmMuteRuleOptions

getAlarmMuteRuleName, getDescription, getDuration, getExpire, getSchedule, getStart, getTags

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAlarms

@Stability(Stable)
@Nullable
default List<IAlarmRef> getAlarms()

The list of alarms that this mute rule targets.

You can specify up to 100 alarms.

Default: - no target alarms

builder

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

Returns:

a AlarmMuteRuleProps.Builder of AlarmMuteRuleProps