Package software.amazon.awscdk.services.cloudwatch

Interface CfnAlarmMuteRuleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAlarmMuteRuleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-02T12:05:05.132Z")
@Stability(Stable)
public interface CfnAlarmMuteRuleProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAlarmMuteRule.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 CfnAlarmMuteRuleProps cfnAlarmMuteRuleProps = CfnAlarmMuteRuleProps.builder()
         .rule(RuleProperty.builder()
                 .schedule(ScheduleProperty.builder()
                         .duration("duration")
                         .expression("expression")
                         // the properties below are optional
                         .timezone("timezone")
                         .build())
                 .build())
         // the properties below are optional
         .description("description")
         .expireDate("expireDate")
         .muteTargets(MuteTargetsProperty.builder()
                 .alarmNames(List.of("alarmNames"))
                 .build())
         .name("name")
         .startDate("startDate")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAlarmMuteRuleProps.Builder	builder()
default String	getDescription()	The description of the AlarmMuteRule.
default String	getExpireDate()	The date, with the same timezone offset as "ScheduleTimezone" after which the alarm mute rule will be expired.
default Object	getMuteTargets()	Targets to be muted.
default String	getName()	The name of the AlarmMuteRule.
Object	getRule()	The rule for the mute.
default String	getStartDate()	The date, with the same timezone offset as "ScheduleTimezone", after which the alarm mute rule will become active.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRule

@Stability(Stable)
@NotNull
Object getRule()

The rule for the mute.

Returns union: either IResolvable or CfnAlarmMuteRule.RuleProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-rule

getDescription

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

The description of the AlarmMuteRule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-description

getExpireDate

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

The date, with the same timezone offset as "ScheduleTimezone" after which the alarm mute rule will be expired.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-expiredate

getMuteTargets

@Stability(Stable)
@Nullable
default Object getMuteTargets()

Targets to be muted.

Returns union: either IResolvable or CfnAlarmMuteRule.MuteTargetsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-mutetargets

getName

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

The name of the AlarmMuteRule.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-name

getStartDate

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

The date, with the same timezone offset as "ScheduleTimezone", after which the alarm mute rule will become active.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-startdate

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html#cfn-cloudwatch-alarmmuterule-tags

builder

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

Returns:

a CfnAlarmMuteRuleProps.Builder of CfnAlarmMuteRuleProps