Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarmMuteRule

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.cloudwatch.CfnAlarmMuteRule
All Implemented Interfaces:
IInspectable, IAlarmMuteRuleRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-02T12:05:05.130Z") @Stability(Stable) public class CfnAlarmMuteRule extends CfnResource implements IInspectable, IAlarmMuteRuleRef, ITaggableV2
Resource Type definition for AWS::CloudWatch::AlarmMuteRule that allows defining a rule and targeting alarms to mute their actions during the specified window.

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.*;
 CfnAlarmMuteRule cfnAlarmMuteRule = CfnAlarmMuteRule.Builder.create(this, "MyCfnAlarmMuteRule")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAlarmMuteRule

      protected CfnAlarmMuteRule(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAlarmMuteRule

      protected CfnAlarmMuteRule(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAlarmMuteRule

      @Stability(Stable) public CfnAlarmMuteRule(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAlarmMuteRuleProps props)
      Create a new AWS::CloudWatch::AlarmMuteRule.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAlarmMuteRule

      @Stability(Stable) @NotNull public static String arnForAlarmMuteRule(@NotNull IAlarmMuteRuleRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAlarmMuteRule

      @Stability(Stable) @NotNull public static Boolean isCfnAlarmMuteRule(@NotNull Object x)
      Checks whether the given object is a CfnAlarmMuteRule.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAlarmMuteRuleRef

      @Stability(Stable) @NotNull public AlarmMuteRuleReference getAlarmMuteRuleRef()
      A reference to a AlarmMuteRule resource.
      Specified by:
      getAlarmMuteRuleRef in interface IAlarmMuteRuleRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      Amazon Resource Name (ARN) of the AlarmMuteRule.

    • getAttrLastUpdatedTimestamp

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTimestamp()
      The last update timestamp of the alarm mute schedule.

    • getAttrMuteType

      @Stability(Stable) @NotNull public String getAttrMuteType()
      The mute type of the alarm mute.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current status of the AlarmMuteRule.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRule

      @Stability(Stable) @NotNull public Object getRule()
      The rule for the mute.

      Returns union: either IResolvable or CfnAlarmMuteRule.RuleProperty

    • setRule

      @Stability(Stable) public void setRule(@NotNull IResolvable value)
      The rule for the mute.

    • setRule

      @Stability(Stable) public void setRule(@NotNull CfnAlarmMuteRule.RuleProperty value)
      The rule for the mute.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the AlarmMuteRule.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the AlarmMuteRule.

    • getExpireDate

      @Stability(Stable) @Nullable public String getExpireDate()
      The date, with the same timezone offset as "ScheduleTimezone" after which the alarm mute rule will be expired.

    • setExpireDate

      @Stability(Stable) public void setExpireDate(@Nullable String value)
      The date, with the same timezone offset as "ScheduleTimezone" after which the alarm mute rule will be expired.

    • getMuteTargets

      @Stability(Stable) @Nullable public Object getMuteTargets()
      Targets to be muted.

      Returns union: either IResolvable or CfnAlarmMuteRule.MuteTargetsProperty

    • setMuteTargets

      @Stability(Stable) public void setMuteTargets(@Nullable IResolvable value)
      Targets to be muted.

    • setMuteTargets

      @Stability(Stable) public void setMuteTargets(@Nullable CfnAlarmMuteRule.MuteTargetsProperty value)
      Targets to be muted.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the AlarmMuteRule.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the AlarmMuteRule.

    • getStartDate

      @Stability(Stable) @Nullable public String getStartDate()
      The date, with the same timezone offset as "ScheduleTimezone", after which the alarm mute rule will become active.

    • setStartDate

      @Stability(Stable) public void setStartDate(@Nullable String value)
      The date, with the same timezone offset as "ScheduleTimezone", after which the alarm mute rule will become active.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.