API Gateway SQS Integration w/ AWS CDK 2.0

This repository is purely for reference and is illustrative in it is purpose. This is one of the many ways of achieving this type of integration.

This project illustrates using the AWS CDK v2 to create an API Gateway endpoint that posts directly into an SQS Queue. A solution seen often is API Gateway to Lambda to SQS, which as a pattern has its uses, however, this can be a lighter implementation if the requirements warrant it.

This example contains request validation, simple VTL transformation as a response, and stack organization by Construct.

Prerequisites

Before you continue, ensure you have met the following requirements:

• AWS CDK CLI 2.8.0 or higher (or use npx)
• an AWS profile configured in ~/.aws/config and ~/.aws/credentials
  • there are instructions to set up an Access Key Credential Type here.

Installation

• clone this repository into a directory of your choosing
• run npm install in that directory

Deployment

This project does not use the standard environment in code solution seen often and opts for AWS profiles instead.

• run cdk deploy --profile <your profile name> if you have defined a non default profile in the ~/.aws files
• run cdk deploy if you have defined a default profile, or have AWS environment variables set

Verifying Deployment

Assuming everything runs smoothly during stack deployment, it is fairly easy to verify that the solution is working. Upon the deployment finishing, the URI of the endpoint will be displayed in the console.

• Use postman, curl, VSCode or other tooling to POST the following JSON to that endpoint

{
    "userId" : "b64bbadd-7593-4e93-a83f-cb92a462c927",
    "latitude" : 33.8337,
    "longitude" : -84.1450
}

• View the created SQS queue, there should be an entry with the data from the POST above

Notes

• This repository is heavily commented to provide context as to what and why, if in VS Code feel free to collapse all comments if they are obtrusive
  • On Mac -> Press ⌘ + K then ⌘ + /
  • On Windows & Linux -> Press Ctrl + K then Ctrl + /
• Generally one would use Constructs to create reusable functionality. In this repository they are used for organization and readability of the code base. There are many available examples that illustrate a large stack completely in the constructor of the stack alone. I wanted to explore a deconstructed configuration this round.