CfnAlarmMuteRuleProps

class aws_cdk.aws_cloudwatch.CfnAlarmMuteRuleProps(*, rule, description=None, expire_date=None, mute_targets=None, name=None, start_date=None, tags=None)

Bases: object

Properties for defining a CfnAlarmMuteRule.

Parameters:
  • rule (Union[IResolvable, RuleProperty, Dict[str, Any]]) – The rule for the mute.

  • description (Optional[str]) – The description of the AlarmMuteRule.

  • expire_date (Optional[str]) – The date, with the same timezone offset as “ScheduleTimezone” after which the alarm mute rule will be expired.

  • mute_targets (Union[IResolvable, MuteTargetsProperty, Dict[str, Any], None]) – Targets to be muted.

  • name (Optional[str]) – The name of the AlarmMuteRule.

  • start_date (Optional[str]) – The date, with the same timezone offset as “ScheduleTimezone”, after which the alarm mute rule will become active.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cfn_alarm_mute_rule_props = cloudwatch.CfnAlarmMuteRuleProps(
    rule=cloudwatch.CfnAlarmMuteRule.RuleProperty(
        schedule=cloudwatch.CfnAlarmMuteRule.ScheduleProperty(
            duration="duration",
            expression="expression",

            # the properties below are optional
            timezone="timezone"
        )
    ),

    # the properties below are optional
    description="description",
    expire_date="expireDate",
    mute_targets=cloudwatch.CfnAlarmMuteRule.MuteTargetsProperty(
        alarm_names=["alarmNames"]
    ),
    name="name",
    start_date="startDate",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

description

The description of the AlarmMuteRule.

See:

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

expire_date

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

See:

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

mute_targets

Targets to be muted.

See:

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

name

The name of the AlarmMuteRule.

See:

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

rule

The rule for the mute.

See:

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

start_date

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

See:

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

tags

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

See:

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