@aws-solutions-konstruk/aws-apigateway-sqs

aws-apigateway-sqs module

---

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:	http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-apigateway-sqs/

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

Overview

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
});

Initializer

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

Parameters

• 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

---

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