Skip to main content

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

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

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

Architecture Diagram


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

Release files for aws-solutions-konstruk.aws-apigateway-sqs 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-konstruk.aws-apigateway-sqs 0.8.1
File Size Uploaded
aws-solutions-konstruk.aws-apigateway-sqs-0.8.1.tar.gz 127.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-konstruk.aws-apigateway-sqs 0.8.1
File Interpreter ABI Platform
aws_solutions_konstruk.aws_apigateway_sqs-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 253.4 kB

Release files / aws-solutions-konstruk.aws-apigateway-sqs-0.8.1.tar.gz

Download URL aws-solutions-konstruk.aws-apigateway-sqs-0.8.1.tar.gz
Size 127.3 kB
Tags Source
SHA-256 checksum
How to use checksums
463b9e66e51dd6cf7f9620f2cb67b9c244eba40dd10355a5d9687e75f80b3d2c
BLAKE2b-256 checksum
How to use checksums
8296cfaaa291802ba6617b5aa3a1ca54d0e57e631d920300d27d07cf2c8a34f9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release files / aws_solutions_konstruk.aws_apigateway_sqs-0.8.1-py3-none-any.whl

Download URL aws_solutions_konstruk.aws_apigateway_sqs-0.8.1-py3-none-any.whl
Size 126.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bfdd126aeb6fdf7f8ce008712cf3b267abb0db52b182f677875053ff627dbc85
BLAKE2b-256 checksum
How to use checksums
ad78c832780074cf193a2e12a43d7b7fd72a93e1adb866ed33ff5f07ca764c01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page