Tutorial: Create a rule with an event pattern - AWS Batch

Tutorial: Create a rule with an event pattern

The following procedure covers how to create a rule with an event pattern.

To create a rule that sends the event to a target when the event matches a defined pattern
Note

This procedure works for all AWS Batch on Amazon ECS, Amazon EKS, and AWS Fargate jobs.

  1. Open the Amazon EventBridge console at https://console.aws.amazon.com/events/.

  2. From the navigation bar, select the AWS Region to use.

  3. In the navigation pane, choose Rules.

  4. Choose Create rule.

  5. For Name, specify a unique name for your compute environment. The name can contain up to 64 characters. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

    Note

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

  6. (Optional) For Description, enter a description for the rule.

  7. 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 default. When an AWS service in your account emits an event, it always goes to your account's default event bus.

  8. (Optional) Turn off the rule on the selected bus if you don't want to run the rule immediately.

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

  10. Choose Next.

  11. For Event Source, choose AWS event or EventBridge partner events.

  12. (Optional) For Sample event:

    1. For Sample event type, choose AWS events.

    2. For Sample events, choose Batch Job State Change.

  13. For Creation method, choose Use pattern form.

  14. For Event pattern:

    1. For Event source, choose AWS services.

    2. For AWS service, choose Batch.

    3. For Event type, choose Batch Job State Change.

  15. Choose Next.

  16. For Target types, choose AWS service.

  17. For Select a target, choose a target type. For example, choose Batch job queue. Then specify the following:

    • Job queue: Enter the Amazon Resource Name (ARN) of the job queue to schedule your job in.

    • Job definition: Enter the name and revision or full ARN of the job definition to use for your job.

    • Job name: Enter a name for your job.

    • Array size: (Optional) Enter an array size for your job to run more than one copy. For more information, see Array jobs.

    • Job attempts: (Optional) Enter the number of times to retry your job if it fails. For more information, see Automated job retries.

  18. For Batch job queue target types, EventBridge needs permission to send events to the target. 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 before, choose Use existing role.

  19. (Optional) Expand Additional settings.

    1. For Configure target input, choose how text from an event is processed.

    2. For Maximum age of event, specify the time interval for how long unprocessed events are kept.

    3. For Retry attempts, enter the number of times that an event is retried.

    4. For Dead-letter queue, choose an option for how unprocessed events are handled. If necessary, specify the Amazon SQS queue to use as the dead-letter queue.

  20. (Optional) Choose Add another target to add an additional target.

  21. Choose Next.

  22. (Optional) For Tags, choose Add new tag to add a resource label. For more information, see Amazon EventBridge tags in the Amazon EventBridge User Guide.

  23. Choose Next.

  24. For Review and create, review the configuration steps. If you need to make changes, choose Edit. After you're finished, choose Create rule.

    For more information about creating rules, see Creating Amazon EventBridge rules that react to events in the Amazon EventBridge User Guide.