Skip to main content

CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.

Project description

aws-apigateway-sqs module


Stability: Experimental

This is a developer preview (public beta) module.

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.

API Reference:
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_solutions_konstruk.aws_apigateway_sqs
Typescript Logo{: style="height:16px;width:16px"} Typescript @aws-solutions-konstruk/aws-apigateway-sqs


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

Here is a minimal deployable pattern definition:

const { ApiGatewayToSqs } = require('@aws-solutions-konstruk/aws-apigateway-sqs');

new ApiGatewayToSqs(stack, 'ApiGatewayToSqsPattern', {
    apiGatewayProps: {},
    queueProps: {},
    encryptionKeyProps: {},
    deployDeadLetterQueue?: true,
    maxReceiveCount?: 3


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


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.
encryptionKeyProps? kms.KeyProps Optional user-provided props to override the default props for the encryption key.
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 unsuccesfully dequeued before being moved to the dead-letter queue.

Pattern Properties

Name Type Description
api() api.RestApi Returns an instance of the API Gateway REST API created by the pattern.
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


Architecture Diagram

© Copyright 2020, Inc. or its affiliates. All Rights Reserved.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for, version 0.8.1
Filename, size File type Python version Upload date Hashes
Filename, size aws_solutions_konstruk.aws_apigateway_sqs-0.8.1-py3-none-any.whl (126.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size (127.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page