Amazon API Gateway HTTP API to AWS Simple Queue Service (SQS) to Lambda

This pattern creates an Amazon API Gateway HTTP API with a send route that send message to a SQS queue. The Amazon API Gateway HTTP API has basic CORS configured. Upon receiving message, SQS will trigger a Lambda function to process the message. The function will only print the message. The function is written in TypeScript.

Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/apigw-http-api-sqs-lambda-sls.

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 for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Requirements

• Create an AWS account 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 installed and configured
• Git CLI installed
• NodeJS (LTS version) installed
• Serverless Framework CLI installed

Deployment Instructions

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

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

2. Change directory to the pattern directory:

   cd serverless-patterns/apigw-http-api-sqs-lambda-sls

3. From the command line, use npm to install the development dependencies:

   npm install

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

   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.

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

5. Note the ApiEndpoint output from the Serverless Framework deployment process. You will use this value for testing.

How it works

The API Gateway handles the incoming API requests and sends the $request.body.MessageBody as a message to an SQS queue. A Lambda function is triggered with the posted message.

Testing

Sending a new test message to API Gateway endpoint

To test the endpoint first send data using the following command. Be sure to update the endpoint with endpoint of your stack.

curl --location --request POST 'ApiEndpoint output value' --header 'Content-Type: application/json' \
--data-raw '{
    "MessageBody":"hello"
}'

Expected output

<?xml version="1.0"?><SendMessageResponse xmlns="http://queue.amazonaws.com/doc/2012-11-05/">
    <SendMessageResult>
        <MessageId>xxxxxx</MessageId>
        <MD5OfMessageBody>xxxxxx</MD5OfMessageBody>
    </SendMessageResult>
    <ResponseMetadata>
        <RequestId>xxxx</RequestId>
    </ResponseMetadata>
</SendMessageResponse>

CloudWatch logs

Open AWS CloudWatch Console and navigate to /aws/lambda/apigw-http-api-sqs-lambda-sls-prod-logEvent log group. You should be able to see a new Event Stream with the Received Event information, and the number of records received, logged into the stream.

Cleanup

1. Delete the stack

   serverless remove --verbose

2. Confirm the stack has been deleted

   aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'apigw-http-api-sqs-lambda-sls-prod')].StackStatus"

   Expected output

   [
       "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 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0