Event Rule
Resource Overview
An Event Rule represents an AWS EventBridge event rule. Event Rules allow you to configure your functions or step functions to be invoked when a message matching the rule is seen on the Event Bus. The triggering message is passed to the target as its input.
Key Features of EventBridge Event Rules include:
- Trigger functions or step functions in response to Event Bus events that match a pattern
- Create Event Rules that monitor the default Event Bus or a custom Event Bus
Event Subscription
Event subscription wires (solid line) visualize and configure event subscription integrations between two resources.
The following resources can be subscribed to an Event Rule:
- Function
- State Machine
Configurable Properties
Display Name
Human readable name for this resource that is displayed on the Stackery Dashboard.
Use Default Event Bus
When enabled, as it is by default, the Event Rule listens on the default Event Bus, which is named "Default". When this option is disabled, the user may specify a custom Event Bus to listen on.
Event Bus Name
The name of a custom Event Bus on which to listen for events.
Event Pattern
The event pattern that the rule will match. A simple pattern is provided as an example, but users will want to substitute a pattern specific to the events they're interested in. AWS documentation of event pattern construction is available here.
IAM Permissions
When connected by a service discovery wire (dashed wire), a Function or Docker Task will add the following IAM policy to its role and gain permission to access this resource.
No Permissions Added
Environment Variables
When connected by a service discovery wire (dashed wire), a Function or Docker Task will automatically populate and reference the following environment variables in order to interact with this resource.
No Environment Variables Added
Metrics & Logs
Double clicking a resource while viewing your stack's current deployment gives you access to your pre-configured resource properties, and the following metrics and logs.
- Invocation Metrics
Related AWS Documentation
AWS Documentation: AWS::Events::Rule