AlarmMuteRuleOptions

class aws_cdk.aws_cloudwatch.AlarmMuteRuleOptions(*, duration, schedule, alarm_mute_rule_name=None, description=None, expire=None, start=None, tags=None)

Bases: object

Options used to configure a CloudWatch alarm mute rule.

Parameters:

  • duration (Duration) – The length of time that alarms remain muted when the schedule activates. Minimum: 1 minute, Maximum: 15 days

  • schedule (ScheduleExpression) – The schedule defines when alarms should be muted.

  • alarm_mute_rule_name (Optional[str]) – The name of the alarm mute rule. This name must be unique within your AWS account and region. Default: - generated by CloudFormation

  • description (Optional[str]) – A description of the alarm mute rule that helps you identify its purpose. Default: - no description

  • expire (Union[CalendarDateTime, Dict[str, Any], None]) – 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

  • start (Union[CalendarDateTime, Dict[str, Any], None]) – 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

  • tags (Optional[Mapping[str, str]]) – A list of tags associated with the alarm mute rule. Tags help you organize and categorize your AWS resources. Default: - No tags are applied

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_cloudwatch as cloudwatch

# schedule_expression: cloudwatch.ScheduleExpression

alarm_mute_rule_options = cloudwatch.AlarmMuteRuleOptions(
    duration=cdk.Duration.minutes(30),
    schedule=schedule_expression,

    # the properties below are optional
    alarm_mute_rule_name="alarmMuteRuleName",
    description="description",
    expire=cloudwatch.CalendarDateTime(
        day=123,
        hour=123,
        minute=123,
        month=123,
        year=123
    ),
    start=cloudwatch.CalendarDateTime(
        day=123,
        hour=123,
        minute=123,
        month=123,
        year=123
    ),
    tags={
        "tags_key": "tags"
    }
)

Attributes

alarm_mute_rule_name

The name of the alarm mute rule.

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

Default:

  • generated by CloudFormation

description

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

Default:

  • no description

duration

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

Minimum: 1 minute, Maximum: 15 days

expire

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

schedule

The schedule defines when alarms should be muted.

start

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

tags

A list of tags associated with the alarm mute rule.

Tags help you organize and categorize your AWS resources.

Default:

  • No tags are applied