Container for the parameters to the PutAlarmMuteRule operation. Creates or updates an alarm mute rule.
Alarm mute rules automatically mute alarm actions during predefined time windows. When a mute rule is active, targeted alarms continue to evaluate metrics and transition between states, but their configured actions (such as Amazon SNS notifications or Auto Scaling actions) are muted.
You can create mute rules with recurring schedules using cron expressions or
one-time mute windows using at expressions. Each mute rule can target up to
100 specific alarms by name.
If you specify a rule name that already exists, this operation updates the existing rule with the new configuration.
Permissions
To create or update a mute rule, you must have the cloudwatch:PutAlarmMuteRule
permission on two types of resources: the alarm mute rule resource itself, and each
alarm that the rule targets.
For example, If you want to allow a user to create mute rules that target only specific
alarms named "WebServerCPUAlarm" and "DatabaseConnectionAlarm", you would create an
IAM policy with one statement granting cloudwatch:PutAlarmMuteRule on the alarm
mute rule resource (arn:aws:cloudwatch:[REGION]:123456789012:alarm-mute:*),
and another statement granting cloudwatch:PutAlarmMuteRule on the targeted
alarm resources (arn:aws:cloudwatch:[REGION]:123456789012:alarm:WebServerCPUAlarm
and arn:aws:cloudwatch:[REGION]:123456789012:alarm:DatabaseConnectionAlarm).
You can also use IAM policy conditions to allow targeting alarms based on resource
tags. For example, you can restrict users to create/update mute rules to only target
alarms that have a specific tag key-value pair, such as Team=TeamA.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.CloudWatch.AmazonCloudWatchRequest
Amazon.CloudWatch.Model.PutAlarmMuteRuleRequest
Namespace: Amazon.CloudWatch.Model
Assembly: AWSSDK.CloudWatch.dll
Version: 3.x.y.z
Syntax
public class PutAlarmMuteRuleRequest : AmazonCloudWatchRequest IAmazonWebServiceRequest
The PutAlarmMuteRuleRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
PutAlarmMuteRuleRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
Description | System.String |
Gets and sets the property Description. A description of the alarm mute rule that helps you identify its purpose. |
|
|
ExpireDate | System.DateTime |
Gets and sets the property ExpireDate. 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. |
|
|
MuteTargets | Amazon.CloudWatch.Model.MuteTargets |
Gets and sets the property MuteTargets. Specifies which alarms this rule applies to. |
|
|
Name | System.String |
Gets and sets the property Name. The name of the alarm mute rule. This name must be unique within your Amazon Web Services account and region. |
|
|
Rule | Amazon.CloudWatch.Model.Rule |
Gets and sets the property Rule. The configuration that defines when and how long alarms should be muted. |
|
|
StartDate | System.DateTime |
Gets and sets the property StartDate. 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. |
|
|
Tags | System.Collections.Generic.List<Amazon.CloudWatch.Model.Tag> |
Gets and sets the property Tags. A list of key-value pairs to associate with the alarm mute rule. You can use tags to categorize and manage your mute rules. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5