AlarmEvents

class aws_cdk.mixins_preview.aws_cloudwatch.events.AlarmEvents(*args: Any, **kwargs)

Bases: object

(experimental) EventBridge event patterns for Alarm.

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
from aws_cdk.interfaces import aws_cloudwatch as interfaces_cloudwatch

# alarm_ref: interfaces_cloudwatch.IAlarmRef

alarm_events = cloudwatch_events.AlarmEvents.from_alarm(alarm_ref)

Methods

cloud_watch_alarm_configuration_change_pattern(*, alarm_name=None, configuration=None, event_metadata=None, operation=None, state=None)

(experimental) EventBridge event pattern for Alarm CloudWatch Alarm Configuration 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: - Do not filter on this field
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: - -
operation (Optional[Sequence[str]]) – (experimental) operation property. Specify an array of string values to match this event if the actual value of operation 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

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

(experimental) EventBridge event pattern for Alarm 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

Static Methods

classmethod from_alarm(alarm_ref)

(experimental) Create AlarmEvents from a Alarm reference.

Parameters:: alarm_ref (IAlarmRef)
Stability:: experimental
Return type:: AlarmEvents