# Amazon EventBridge to Amazon SQS

The AWS SAM template deploys an SQS queue that is triggered by an EventBridge rule. The SQS queue policy provides the permission for EventBridge to send messages to the SQS queue.

Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/eventbridge-sqs.

Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

## Requirements

* [Create an AWS account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) if you do not already have one and log in. The IAM user that you use must have sufficient permissions to make necessary AWS service calls and manage AWS resources.
* [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html) installed and configured
* [Git CLI](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed
* [NodeJS](https://nodejs.org/en/download/) (LTS version) installed
* [Serverless Framework CLI](https://www.serverless.com/framework/docs/getting-started) installed

## Deployment Instructions

1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:

    ``` sh
    git clone https://github.com/aws-samples/serverless-patterns
    ```

1. Change directory to the pattern directory:

    ``` sh
    cd serverless-patterns/eventbridge-sqs-sls
    ```

1. From the command line, use Serverless Framework to deploy the AWS resources for the pattern as specified in the serverless.yml file:

    ``` sh
    serverless deploy --verbose
    ```

    The above command will deploy resources to `us-east-1` region by default. You can override the target region with `--region <region>` CLI option, e.g.

    ``` sh
    serverless deploy --verbose --region us-west-2
    ```

1. Note the `SQSqueueURL` output from the deployment process. You will use this value for testing.

## How it works

The `serverless.yml` template defines the resources and the IAM permissions required to run the application.

In this example, the EventBridge rule specified in `serverless.yml` filters the events based upon the criteria in the `EventPattern` section. When matching events are sent to EventBridge that trigger the rule, they are delivered as a JSON event payload (see "Example event payload from EventBridge to SQS" in the README) to the SQS queue.

## Testing

Use the [AWS CLI](https://aws.amazon.com/cli/) to send a test event to EventBridge. You might need to use `--region <region>` option for all AWS CLI commands if AWS CLI default region is different from the Serverless Framework's region (`us-east-1` by default):

1. Send an event to EventBridge:

    ``` sh
    aws events put-events --entries file://event.json
    ```

    expected output:

    ``` json
    {
        "FailedEntryCount": 0,
        "Entries": [
            {
                "EventId": "00000000-0000-0000-0000-000000000000"
            }
        ]
    }
    ```

1. Retrieve the message from the SQS queue, using the queue URL from the AWS SAM deployment outputs:

    ``` sh
    aws sqs receive-message --queue-url <SQSqueueURL>
    ```

    expected output:

    ```json
    {                                                                                                              
        "Messages": [
            {
                "MessageId": "12345678-68cf-4b7c-8513-123456789012",
                "ReceiptHandle": "AQEBxt123456789012WtqHJEI3UstldOHB0123456789012o699ZQb34s+WS9b72u123456789012m/nDByiV8kIdM0hXs1m+53z123456789012aucGe0UoFOH/A8ty7FrZdmlH6123456789012RsFsWWUCxMJ68qOTHNrmfP123456789012q0fNpAJaejha5co1wtA1s8k+fmJr43YtCWX123456789012682oG9V6LuVS123456789012G99uuePgIW1y123456789012KD0+123456789012r/RFf9F1pAEtqMPF+LkxWMMOQv123456789012UD3luTtDmEm+tE1234567890125nNWJ/123456789012/123456789012=",
                "MD5OfBody": "12345678901265371af6123456789012",
                "Body": "{\"version\":\"0\",\"id\":\"1234567806dd-6089-df65-2c51-123456789012\",\"detail-type\":\"transaction\",\"source\":\"demo.sqs\",\"account\":\"123456789012\",\"time\":\"2021-02-10T16:41:20Z\",\"region\":\"us-east-1\",\"resources\":[],\"detail\":{\"msg\":\"test\"}}"
            }
        ]
    }
    ```

## Cleanup

1. Delete the stack

    ```sh
    serverless remove --verbose
    ```

1. Confirm the stack has been deleted

    ```sh
    aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'eventbridge-sqs-sls-prod')].StackStatus"
    ```

    Expected output

    ```json
    [
        "DELETE_COMPLETE"
    ]
    ```

    NOTE: You might need to add `--region <region>` option to AWS CLI command if you AWS CLI default region does not match the one, that you used for the Serverless Framework deployment.

----
Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0