CfnAlarmMuteRulePropsMixin

class aws_cdk.mixins_preview.aws_cloudwatch.mixins.CfnAlarmMuteRulePropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::CloudWatch::AlarmMuteRule that allows defining a rule and targeting alarms to mute their actions during the specified window.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudwatch-alarmmuterule.html
CloudformationResource:: AWS::CloudWatch::AlarmMuteRule
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cloudwatch import mixins as cloudwatch_mixins

cfn_alarm_mute_rule_props_mixin = cloudwatch_mixins.CfnAlarmMuteRulePropsMixin(cloudwatch_mixins.CfnAlarmMuteRuleMixinProps(
    description="description",
    expire_date="expireDate",
    mute_targets=cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.MuteTargetsProperty(
        alarm_names=["alarmNames"]
    ),
    name="name",
    rule=cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.RuleProperty(
        schedule=cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.ScheduleProperty(
            duration="duration",
            expression="expression",
            timezone="timezone"
        )
    ),
    start_date="startDate",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CloudWatch::AlarmMuteRule.

Parameters:

props (Union[CfnAlarmMuteRuleMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'expireDate', 'muteTargets', 'name', 'rule', 'startDate', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

MuteTargetsProperty

class CfnAlarmMuteRulePropsMixin.MuteTargetsProperty(*, alarm_names=None)

Bases: object

Targets to be muted.

Parameters:: alarm_names (Optional[Sequence[str]]) – The alarm names to be mute by the AlarmMuteRule.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarmmuterule-mutetargets.html
ExampleMetadata:: fixture=_generated

Example:

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

mute_targets_property = cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.MuteTargetsProperty(
    alarm_names=["alarmNames"]
)

Attributes

alarm_names

The alarm names to be mute by the AlarmMuteRule.

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

RuleProperty

class CfnAlarmMuteRulePropsMixin.RuleProperty(*, schedule=None)

Bases: object

The rule for the mute.

Parameters:: schedule (Union[IResolvable, ScheduleProperty, Dict[str, Any], None]) – Schedule for the mute to be active.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarmmuterule-rule.html
ExampleMetadata:: fixture=_generated

Example:

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

rule_property = cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.RuleProperty(
    schedule=cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.ScheduleProperty(
        duration="duration",
        expression="expression",
        timezone="timezone"
    )
)

Attributes

schedule

Schedule for the mute to be active.

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

ScheduleProperty

class CfnAlarmMuteRulePropsMixin.ScheduleProperty(*, duration=None, expression=None, timezone=None)

Bases: object

Schedule for the mute to be active.

Parameters:

duration (Optional[str]) – The duration of the schedule when it triggers.
expression (Optional[str]) – The expression of the schedule.
timezone (Optional[str]) – The timezone of the schedule.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

schedule_property = cloudwatch_mixins.CfnAlarmMuteRulePropsMixin.ScheduleProperty(
    duration="duration",
    expression="expression",
    timezone="timezone"
)

Attributes

duration

The duration of the schedule when it triggers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarmmuterule-schedule.html#cfn-cloudwatch-alarmmuterule-schedule-duration

expression

The expression of the schedule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarmmuterule-schedule.html#cfn-cloudwatch-alarmmuterule-schedule-expression

timezone

The timezone of the schedule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarmmuterule-schedule.html#cfn-cloudwatch-alarmmuterule-schedule-timezone