aws-apigateway-sqs - AWS Solutions Constructs

aws-apigateway-sqs

All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

Language Package
Python
aws_solutions_constructs.aws_apigateway_sqs
Typescript
@aws-solutions-constructs/aws-apigateway-sqs
Java
software.amazon.awsconstructs.services.apigatewaysqs

Overview

This AWS Solutions Constructs pattern implements an Amazon API Gateway connected to an Amazon SQS queue pattern.

Here is a minimal deployable pattern definition:

const { ApiGatewayToSqs } = require('@aws-solutions-constructs/aws-apigateway-sqs'); new ApiGatewayToSqs(stack, 'ApiGatewayToSqsPattern', { apiGatewayProps: {}, queueProps: {}, deployDeadLetterQueue: true, maxReceiveCount: 3 });

Initializer

new ApiGatewayToSqs(scope: Construct, id: string, props: ApiGatewayToSqsProps);

Parameters

Pattern Construct Props

Name Type Description
apiGatewayProps? api.RestApiProps Optional user-provided props to override the default props for the API Gateway.
queueProps? sqs.QueueProps Optional user-provided props to override the default props for the queue.
deployDeadLetterQueue boolean Whether to deploy a secondary queue to be used as a dead letter queue.
maxReceiveCount number The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
allowCreateOperation? boolean Whether to deploy an API Gateway Method for Create operations on the queue (i.e. sqs:SendMessage).
createRequestTemplate? string API Gateway Request template for Create method, required if allowCreateOperation set to true.
allowReadOperation? boolean Whether to deploy an API Gateway Method for Read operations on the queue (i.e. sqs:ReceiveMessage).
allowDeleteOperation? boolean Whether to deploy an API Gateway Method for Delete operations on the queue (i.e. sqs:DeleteMessage).

Pattern Properties

Name Type Description
apiGateway api.RestApi Returns an instance of the API Gateway REST API created by the pattern.
apiGatewayCloudWatchRole iam.Role Returns an instance of the IAM role created by the pattern that enables access logging from the API Gateway REST API to CloudWatch.
apiGatewayLogGroup logs.LogGroup Returns an instance of the log group created by the pattern that API Gateway REST API access logs are sent to.
apiGatewayRole iam.Role Returns an instance of the IAM role created by the pattern for the API Gateway REST API.
deadLetterQueue? sqs.Queue Returns an instance of the dead letter queue created by the pattern, if one is deployed.
sqsQueue sqs.Queue Returns an instance of the SQS queue created by the pattern.

Sample API Usage

Method Request Path Request Body Queue Action Description
GET / sqs::ReceiveMessage Retrieves a message from the queue.
POST / { "data": "Hello World!" } sqs::SendMessage Delivers a message to the queue.
DELETE /message?receiptHandle=[value] sqs::DeleteMessage Deletes a specified message from the queue

Default settings

Out-of-the-box implementation of this pattern without any overrides will set the following defaults:

Amazon API Gateway

  • Deploy an edge-optimized API endpoint

  • Enable CloudWatch logging for API Gateway

  • Configure least privilege access IAM role for API Gateway

  • Set the default authorizationType for all API methods to IAM

Amazon SQS Queue

  • Deploy SQS dead-letter queue for the source SQS Queue

  • Enable server-side encryption for source SQS Queue using AWS managed KMS Key

  • Enforce encryption of data in transit

Architecture