Getting started with Amazon EventBridge - Amazon EventBridge
Create rule
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

Getting started with Amazon EventBridge

The basis of EventBridge is to create rules that route events to a target. In this section, you create a basic rule. For tutorials about specific scenarios and specific targets, see Amazon EventBridge tutorials.

Create a rule in Amazon EventBridge

To create a rule for events, you specify an action to take when EventBridge receives an event that matches the event pattern in the rule. When an event matches, EventBridge sends the event to the specified target and triggers the action defined in the rule.

When an Amazon service in your Amazon account emits an event, it always goes to the default event bus for your account. To write a rule that matches events from Amazon services in your account, you must associate it with the default event bus.

To create a rule for an Amazon service

  1. Open the Amazon EventBridge console at https://console.amazonaws.cn/events/.

  2. In the navigation pane, choose Rules.

  3. Choose Create rule.

  4. Enter a name and description for the rule.

    A rule can't have the same name as another rule in the same Region and on the same event bus.

  5. For Event bus, choose the event bus that you want to associate with this rule. If you want this rule to match events that come from your account, select Amazon default event bus. When an Amazon service in your account emits an event, it always goes to your account’s default event bus.

  6. For Rule type, choose Rule with an event pattern.

  7. Choose Next.

  8. For Event source, choose Amazon services.

  9. (Optional) For Sample events, choose the type of event.

  10. For Event pattern, do one the following:

    • To use a template to create your event pattern, choose Event pattern form and choose the Event source and Event type. If you choose All Events as the event type, all events emitted by this Amazon service will match the rule.

      To customize the template, choose Custom pattern (JSON editor) and make your changes.

    • To use a custom event pattern, choose Custom pattern (JSON editor) and create your event pattern.

  11. Choose Next.

  12. For Target types, choose Amazon service.

  13. For Select a target, choose the Amazon service that you want to send information to when EventBridge detects an event that matches the event pattern.

  14. The fields displayed vary depending on the service you choose. Enter information specific to this target type as needed.

  15. For many target types, EventBridge needs permissions to send events to the target. In these cases, EventBridge can create the IAM role needed for your rule to run. Do one of the following:

    • To create an IAM role automatically, choose Create a new role for this specific resource.

    • To use an IAM role that you created earlier, choose Use existing role and select the existing role from the drop-down list.

  16. (Optional) For Additional settings, do the following:

    1. For Maximum age of event, enter a value between one minute (00:01) and 24 hours (24:00).

    2. For Retry attempts, enter a number between 0 and 185.

    3. For Dead-letter queue, choose whether to use a standard Amazon SQS queue as a dead-letter queue. EventBridge sends events that match this rule to the dead-letter queue if they are not successfully delivered to the target. Do one of the following:

      • Choose None to not use a dead-letter queue.

      • Choose Select an Amazon SQS queue in the current Amazon account to use as the dead-letter queue and then select the queue to use from the drop-down list.

      • Choose Select an Amazon SQS queue in an other Amazon account as a dead-letter queue and then enter the ARN of the queue to use. You must attach a resource-based policy to the queue that grants EventBridge permission to send messages to it. For more information, see Granting permissions to the dead-letter queue.

  17. (Optional) Choose Add another target to add another target for this rule.

  18. Choose Next.

  19. (Optional) Enter one or more tags for the rule. For more information, see Amazon EventBridge tags.

  20. Choose Next.

  21. Review the details of the rule and choose Create rule.