CloudWatchAlarmStateChange

class aws_cdk.mixins_preview.aws_cloudwatch.events.CloudWatchAlarmStateChange

Bases: object

(experimental) EventBridge event pattern for aws.cloudwatch@CloudWatchAlarmStateChange.

Stability:: experimental
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 events as cloudwatch_events

cloud_watch_alarm_state_change = cloudwatch_events.CloudWatchAlarmStateChange()

Stability:: experimental

Static Methods

classmethod cloud_watch_alarm_state_change_pattern(*, alarm_name=None, configuration=None, event_metadata=None, previous_state=None, state=None)

(experimental) EventBridge event pattern for CloudWatch Alarm State Change.

Parameters:

alarm_name (Optional[Sequence[str]]) – (experimental) alarmName property. Specify an array of string values to match this event if the actual value of alarmName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Alarm reference
configuration (Union[Configuration, Dict[str, Any], None]) – (experimental) configuration property. Specify an array of string values to match this event if the actual value of configuration is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
previous_state (Union[State, Dict[str, Any], None]) – (experimental) previousState property. Specify an array of string values to match this event if the actual value of previousState is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
state (Union[State, Dict[str, Any], None]) – (experimental) state property. Specify an array of string values to match this event if the actual value of state is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

Return type:

EventPattern

CloudWatchAlarmStateChangeProps

class CloudWatchAlarmStateChange.CloudWatchAlarmStateChangeProps(*, alarm_name=None, configuration=None, event_metadata=None, previous_state=None, state=None)

Bases: object

(experimental) Props type for aws.cloudwatch@CloudWatchAlarmStateChange event.

Parameters:

alarm_name (Optional[Sequence[str]]) – (experimental) alarmName property. Specify an array of string values to match this event if the actual value of alarmName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Filter with the Alarm reference
configuration (Union[Configuration, Dict[str, Any], None]) – (experimental) configuration property. Specify an array of string values to match this event if the actual value of configuration is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
event_metadata (Union[AWSEventMetadataProps, Dict[str, Any], None]) – (experimental) EventBridge event metadata. Default: - -
previous_state (Union[State, Dict[str, Any], None]) – (experimental) previousState property. Specify an array of string values to match this event if the actual value of previousState is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
state (Union[State, Dict[str, Any], None]) – (experimental) state property. Specify an array of string values to match this event if the actual value of state is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import AWSEventMetadataProps
# 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 events as cloudwatch_events

cloud_watch_alarm_state_change_props = cloudwatch_events.CloudWatchAlarmStateChange.CloudWatchAlarmStateChangeProps(
    alarm_name=["alarmName"],
    configuration=cloudwatch_events.CloudWatchAlarmStateChange.Configuration(
        actions_suppressor=["actionsSuppressor"],
        actions_suppressor_extension_period=["actionsSuppressorExtensionPeriod"],
        actions_suppressor_wait_period=["actionsSuppressorWaitPeriod"],
        alarm_rule=["alarmRule"],
        description=["description"],
        metrics=[cloudwatch_events.CloudWatchAlarmStateChange.ConfigurationItem(
            id=["id"],
            metric_stat=cloudwatch_events.CloudWatchAlarmStateChange.MetricStat(
                metric=cloudwatch_events.CloudWatchAlarmStateChange.Metric(
                    dimensions=["dimensions"],
                    name=["name"],
                    namespace=["namespace"]
                ),
                period=["period"],
                stat=["stat"]
            ),
            return_data=["returnData"]
        )]
    ),
    event_metadata=AWSEventMetadataProps(
        region=["region"],
        resources=["resources"],
        version=["version"]
    ),
    previous_state=cloudwatch_events.CloudWatchAlarmStateChange.State(
        actions_suppressed_by=["actionsSuppressedBy"],
        actions_suppressed_reason=["actionsSuppressedReason"],
        evaluation_state=["evaluationState"],
        reason=["reason"],
        reason_data=["reasonData"],
        timestamp=["timestamp"],
        value=["value"]
    ),
    state=cloudwatch_events.CloudWatchAlarmStateChange.State(
        actions_suppressed_by=["actionsSuppressedBy"],
        actions_suppressed_reason=["actionsSuppressedReason"],
        evaluation_state=["evaluationState"],
        reason=["reason"],
        reason_data=["reasonData"],
        timestamp=["timestamp"],
        value=["value"]
    )
)

Attributes

alarm_name

(experimental) alarmName property.

Specify an array of string values to match this event if the actual value of alarmName is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Filter with the Alarm reference

Stability:

experimental

configuration

(experimental) configuration property.

Specify an array of string values to match this event if the actual value of configuration is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

event_metadata

(experimental) EventBridge event metadata.

Default:

Stability:: experimental

previous_state

(experimental) previousState property.

Specify an array of string values to match this event if the actual value of previousState is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

state

(experimental) state property.

Specify an array of string values to match this event if the actual value of state is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

Configuration

class CloudWatchAlarmStateChange.Configuration(*, actions_suppressor=None, actions_suppressor_extension_period=None, actions_suppressor_wait_period=None, alarm_rule=None, description=None, metrics=None)

Bases: object

(experimental) Type definition for Configuration.

Parameters:

actions_suppressor (Optional[Sequence[str]]) – (experimental) actionsSuppressor property. Specify an array of string values to match this event if the actual value of actionsSuppressor is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
actions_suppressor_extension_period (Optional[Sequence[str]]) – (experimental) actionsSuppressorExtensionPeriod property. Specify an array of string values to match this event if the actual value of actionsSuppressorExtensionPeriod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
actions_suppressor_wait_period (Optional[Sequence[str]]) – (experimental) actionsSuppressorWaitPeriod property. Specify an array of string values to match this event if the actual value of actionsSuppressorWaitPeriod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
alarm_rule (Optional[Sequence[str]]) – (experimental) alarmRule property. Specify an array of string values to match this event if the actual value of alarmRule is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
description (Optional[Sequence[str]]) – (experimental) description property. Specify an array of string values to match this event if the actual value of description is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
metrics (Optional[Sequence[Union[ConfigurationItem, Dict[str, Any]]]]) – (experimental) metrics property. Specify an array of string values to match this event if the actual value of metrics is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

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 events as cloudwatch_events

configuration = cloudwatch_events.CloudWatchAlarmStateChange.Configuration(
    actions_suppressor=["actionsSuppressor"],
    actions_suppressor_extension_period=["actionsSuppressorExtensionPeriod"],
    actions_suppressor_wait_period=["actionsSuppressorWaitPeriod"],
    alarm_rule=["alarmRule"],
    description=["description"],
    metrics=[cloudwatch_events.CloudWatchAlarmStateChange.ConfigurationItem(
        id=["id"],
        metric_stat=cloudwatch_events.CloudWatchAlarmStateChange.MetricStat(
            metric=cloudwatch_events.CloudWatchAlarmStateChange.Metric(
                dimensions=["dimensions"],
                name=["name"],
                namespace=["namespace"]
            ),
            period=["period"],
            stat=["stat"]
        ),
        return_data=["returnData"]
    )]
)

Attributes

actions_suppressor

(experimental) actionsSuppressor property.

Specify an array of string values to match this event if the actual value of actionsSuppressor is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

actions_suppressor_extension_period

(experimental) actionsSuppressorExtensionPeriod property.

Specify an array of string values to match this event if the actual value of actionsSuppressorExtensionPeriod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

actions_suppressor_wait_period

(experimental) actionsSuppressorWaitPeriod property.

Specify an array of string values to match this event if the actual value of actionsSuppressorWaitPeriod is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

alarm_rule

(experimental) alarmRule property.

Specify an array of string values to match this event if the actual value of alarmRule is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

description

(experimental) description property.

Specify an array of string values to match this event if the actual value of description is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

metrics

(experimental) metrics property.

Specify an array of string values to match this event if the actual value of metrics is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

ConfigurationItem

class CloudWatchAlarmStateChange.ConfigurationItem(*, id=None, metric_stat=None, return_data=None)

Bases: object

(experimental) Type definition for ConfigurationItem.

Parameters:

id (Optional[Sequence[str]]) – (experimental) id property. Specify an array of string values to match this event if the actual value of id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
metric_stat (Union[MetricStat, Dict[str, Any], None]) – (experimental) metricStat property. Specify an array of string values to match this event if the actual value of metricStat is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
return_data (Optional[Sequence[str]]) – (experimental) returnData property. Specify an array of string values to match this event if the actual value of returnData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

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 events as cloudwatch_events

configuration_item = cloudwatch_events.CloudWatchAlarmStateChange.ConfigurationItem(
    id=["id"],
    metric_stat=cloudwatch_events.CloudWatchAlarmStateChange.MetricStat(
        metric=cloudwatch_events.CloudWatchAlarmStateChange.Metric(
            dimensions=["dimensions"],
            name=["name"],
            namespace=["namespace"]
        ),
        period=["period"],
        stat=["stat"]
    ),
    return_data=["returnData"]
)

Attributes

id

(experimental) id property.

Specify an array of string values to match this event if the actual value of id is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

metric_stat

(experimental) metricStat property.

Specify an array of string values to match this event if the actual value of metricStat is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

return_data

(experimental) returnData property.

Specify an array of string values to match this event if the actual value of returnData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

Metric

class CloudWatchAlarmStateChange.Metric(*, dimensions=None, name=None, namespace=None)

Bases: object

(experimental) Type definition for Metric.

Parameters:

dimensions (Optional[Sequence[str]]) – (experimental) dimensions property. Specify an array of string values to match this event if the actual value of dimensions is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
name (Optional[Sequence[str]]) – (experimental) name property. Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
namespace (Optional[Sequence[str]]) – (experimental) namespace property. Specify an array of string values to match this event if the actual value of namespace is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

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 events as cloudwatch_events

metric = cloudwatch_events.CloudWatchAlarmStateChange.Metric(
    dimensions=["dimensions"],
    name=["name"],
    namespace=["namespace"]
)

Attributes

dimensions

(experimental) dimensions property.

Specify an array of string values to match this event if the actual value of dimensions is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

name

(experimental) name property.

Specify an array of string values to match this event if the actual value of name is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

namespace

(experimental) namespace property.

Specify an array of string values to match this event if the actual value of namespace is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

MetricStat

class CloudWatchAlarmStateChange.MetricStat(*, metric=None, period=None, stat=None)

Bases: object

(experimental) Type definition for MetricStat.

Parameters:

metric (Union[Metric, Dict[str, Any], None]) – (experimental) metric property. Specify an array of string values to match this event if the actual value of metric is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
period (Optional[Sequence[str]]) – (experimental) period property. Specify an array of string values to match this event if the actual value of period is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
stat (Optional[Sequence[str]]) – (experimental) stat property. Specify an array of string values to match this event if the actual value of stat is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

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 events as cloudwatch_events

metric_stat = cloudwatch_events.CloudWatchAlarmStateChange.MetricStat(
    metric=cloudwatch_events.CloudWatchAlarmStateChange.Metric(
        dimensions=["dimensions"],
        name=["name"],
        namespace=["namespace"]
    ),
    period=["period"],
    stat=["stat"]
)

Attributes

metric

(experimental) metric property.

Specify an array of string values to match this event if the actual value of metric is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

period

(experimental) period property.

Specify an array of string values to match this event if the actual value of period is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

stat

(experimental) stat property.

Specify an array of string values to match this event if the actual value of stat is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

State

class CloudWatchAlarmStateChange.State(*, actions_suppressed_by=None, actions_suppressed_reason=None, evaluation_state=None, reason=None, reason_data=None, timestamp=None, value=None)

Bases: object

(experimental) Type definition for State.

Parameters:

actions_suppressed_by (Optional[Sequence[str]]) – (experimental) actionsSuppressedBy property. Specify an array of string values to match this event if the actual value of actionsSuppressedBy is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
actions_suppressed_reason (Optional[Sequence[str]]) – (experimental) actionsSuppressedReason property. Specify an array of string values to match this event if the actual value of actionsSuppressedReason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
evaluation_state (Optional[Sequence[str]]) – (experimental) evaluationState property. Specify an array of string values to match this event if the actual value of evaluationState is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason (Optional[Sequence[str]]) – (experimental) reason property. Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
reason_data (Optional[Sequence[str]]) – (experimental) reasonData property. Specify an array of string values to match this event if the actual value of reasonData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
timestamp (Optional[Sequence[str]]) – (experimental) timestamp property. Specify an array of string values to match this event if the actual value of timestamp is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field
value (Optional[Sequence[str]]) – (experimental) value property. Specify an array of string values to match this event if the actual value of value is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options. Default: - Do not filter on this field

Stability:

experimental

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 events as cloudwatch_events

state = cloudwatch_events.CloudWatchAlarmStateChange.State(
    actions_suppressed_by=["actionsSuppressedBy"],
    actions_suppressed_reason=["actionsSuppressedReason"],
    evaluation_state=["evaluationState"],
    reason=["reason"],
    reason_data=["reasonData"],
    timestamp=["timestamp"],
    value=["value"]
)

Attributes

actions_suppressed_by

(experimental) actionsSuppressedBy property.

Specify an array of string values to match this event if the actual value of actionsSuppressedBy is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

actions_suppressed_reason

(experimental) actionsSuppressedReason property.

Specify an array of string values to match this event if the actual value of actionsSuppressedReason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

evaluation_state

(experimental) evaluationState property.

Specify an array of string values to match this event if the actual value of evaluationState is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

reason

(experimental) reason property.

Specify an array of string values to match this event if the actual value of reason is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

reason_data

(experimental) reasonData property.

Specify an array of string values to match this event if the actual value of reasonData is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

timestamp

(experimental) timestamp property.

Specify an array of string values to match this event if the actual value of timestamp is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental

value

(experimental) value property.

Specify an array of string values to match this event if the actual value of value is one of the values in the array. Use one of the constructors on the aws_events.Match for more advanced matching options.

Default:

Do not filter on this field

Stability:

experimental