Skip to content

EventRuleStructure

Source code in docs_src/capo_notifications/types/event_rule_structure.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class EventRuleStructure(TypedDict, closed=True):
    arn: "capo_notifications.types.event_rule_arn.EventRuleArn"
    """<p>The Amazon Resource Name (ARN) of the <code>EventRule</code>. CloudFormation stack generates this ARN and then uses this ARN to associate with the <code>NotificationConfiguration</code>.</p>"""
    notification_configuration_arn: "capo_notifications.types.notification_configuration_arn.NotificationConfigurationArn"
    """<p>The ARN for the <code>NotificationConfiguration</code> associated with this <code>EventRule</code>.</p>"""
    creation_time: "capo_notifications.types.creation_time.CreationTime"
    """<p>The creation time of the <code>EventRule</code>.</p>"""
    source: "capo_notifications.types.source.Source"
    """<p>The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, <code>aws.ec2</code> and <code>aws.cloudwatch</code>. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i> Amazon EventBridge User Guide</i>.</p>"""
    event_type: "capo_notifications.types.event_type.EventType"
    """<p>The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-service-event.html#eb-service-event-delivery-level">Event delivery from Amazon Web Services services</a> in the <i> Amazon EventBridge User Guide</i>.</p>"""
    event_pattern: (
        "capo_notifications.types.event_rule_event_pattern.EventRuleEventPattern"
    )
    """<p>An additional event pattern used to further filter the events this <code>EventRule</code> receives.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-event-patterns.html">Amazon EventBridge event patterns</a> in the <i>Amazon EventBridge User Guide.</i> </p>"""
    regions: "capo_notifications.types.regions.Regions"
    """<p>A list of Amazon Web Services Regions that send events to this <code>EventRule</code>.</p>"""
    managed_rules: "capo_notifications.types.managed_rule_arns.ManagedRuleArns"
    """<p>A list of Amazon EventBridge Managed Rule ARNs associated with this <code>EventRule</code>.</p> <note> <p>These are created by User Notifications within your account so your <code>EventRules</code> can function.</p> </note>"""
    status_summary_by_region: (
        "capo_notifications.types.status_summary_by_region.StatusSummaryByRegion"
    )
    """<p>A list of an <code>EventRule</code>'s status by Region. Regions are mapped to <code>EventRuleStatusSummary</code>.</p>"""

arn instance-attribute 

arn: EventRuleArn

The Amazon Resource Name (ARN) of the EventRule. CloudFormation stack generates this ARN and then uses this ARN to associate with the NotificationConfiguration.

creation_time instance-attribute 

creation_time: CreationTime

The creation time of the EventRule.

event_pattern instance-attribute 

event_pattern: EventRuleEventPattern

An additional event pattern used to further filter the events this EventRule receives.

For more information, see Amazon EventBridge event patterns in the Amazon EventBridge User Guide.

event_type instance-attribute 

event_type: EventType

The event type this rule should match with the EventBridge events. It must match with atleast one of the valid EventBridge event types. For example, Amazon EC2 Instance State change Notification and Amazon CloudWatch State Change. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

managed_rules instance-attribute 

managed_rules: ManagedRuleArns

A list of Amazon EventBridge Managed Rule ARNs associated with this EventRule.

These are created by User Notifications within your account so your EventRules can function.

notification_configuration_arn instance-attribute 

notification_configuration_arn: NotificationConfigurationArn

The ARN for the NotificationConfiguration associated with this EventRule.

regions instance-attribute 

regions: Regions

A list of Amazon Web Services Regions that send events to this EventRule.

source instance-attribute 

source: Source

The event source this rule should match with the EventBridge event sources. It must match with atleast one of the valid EventBridge event sources. Only Amazon Web Services service sourced events are supported. For example, aws.ec2 and aws.cloudwatch. For more information, see Event delivery from Amazon Web Services services in the Amazon EventBridge User Guide.

status_summary_by_region instance-attribute 

status_summary_by_region: StatusSummaryByRegion

A list of an EventRule's status by Region. Regions are mapped to EventRuleStatusSummary.