@aws-solutions-constructs/aws-apigateway-sqs
TypeScript icon, indicating that this package has built-in type declarations

2.55.0 • Public • Published

aws-apigateway-sqs module


Stability: Stable


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_apigateway_sqs
Typescript Logo Typescript @aws-solutions-constructs/aws-apigateway-sqs
Java Logo Java software.amazon.awsconstructs.services.apigatewaysqs

Overview

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

Here is a minimal deployable pattern definition:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { ApiGatewayToSqs, ApiGatewayToSqsProps } from "@aws-solutions-constructs/aws-apigateway-sqs";

new ApiGatewayToSqs(this, 'ApiGatewayToSqsPattern', {});

Python

from aws_solutions_constructs.aws_apigateway_sqs import ApiGatewayToSqs
from aws_cdk import Stack
from constructs import Construct

ApiGatewayToSqs(self, 'ApiGatewayToSqsPattern')

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awsconstructs.services.apigatewaysqs.*;

new ApiGatewayToSqs(this, "ApiGatewayToSqsPattern", new ApiGatewayToSqsProps.Builder()
        .build());

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. Defaults to true.
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 POST HTTP operations on the queue (i.e. sqs:SendMessage).
createRequestTemplate? string API Gateway Request Template for the create method for the default application/json content-type. This property is required if the allowCreateOperation property is set to true.
additionalCreateRequestTemplates? { [contentType: string]: string; } Optional Create Request Templates for content-types other than application/json. Use the createRequestTemplate property to set the request template for the application/json content-type. This property can only be specified if the allowCreateOperation property is set to true.
createIntegrationResponses? api.IntegrationResponses[] Optional, custom API Gateway Integration Response for the create method. This property can only be specified if the allowCreateOperation property is set to true.
allowReadOperation? boolean Whether to deploy an API Gateway Method for GET HTTP operations on the queue (i.e. sqs:ReceiveMessage).
readRequestTemplate? string API Gateway Request Template for the read method for the default application/json content-type.
additionalReadRequestTemplates? { [contentType: string]: string; } Optional Read Request Templates for content-types other than application/json. Use the readRequestTemplate property to set the request template for the application/json content-type.
readIntegrationResponses? api.IntegrationResponses[] Optional, custom API Gateway Integration Response for the read method.
allowDeleteOperation? boolean Whether to deploy an API Gateway Method for HTTP DELETE operations on the queue (i.e. sqs:DeleteMessage).
deleteRequestTemplate? string API Gateway Request Template for THE delete method for the default application/json content-type. This property can only be specified if the allowDeleteOperation property is set to true.
additionalDeleteRequestTemplates? { [contentType: string]: string; } Optional Delete request templates for content-types other than application/json. Use the deleteRequestTemplate property to set the request template for the application/json content-type. This property can only be specified if the allowDeleteOperation property is set to true.
deleteIntegrationResponses? api.IntegrationResponses[] Optional, custom API Gateway Integration Response for the delete method. This property can only be specified if the allowDeleteOperation property is set to true.
logGroupProps? logs.LogGroupProps User provided props to override the default props for for the CloudWatchLogs LogGroup.
enableEncryptionWithCustomerManagedKey? boolean If no key is provided, this flag determines whether the queue is encrypted with a new CMK or an AWS managed key. This flag is ignored if any of the following are defined: queueProps.encryptionMasterKey, encryptionKey or encryptionKeyProps.
encryptionKey? kms.Key An optional, imported encryption key to encrypt the SQS Queue with.
encryptionKeyProps? kms.KeyProps Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.

Pattern Properties

Name Type Description
apiGateway api.RestApi Returns an instance of the API Gateway REST API created by the pattern.
apiGatewayRole iam.Role Returns an instance of the iam.Role created by the construct for API Gateway.
apiGatewayCloudWatchRole? iam.Role Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.
apiGatewayLogGroup logs.LogGroup Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.
sqsQueue sqs.Queue Returns an instance of the SQS queue created by the pattern.
deadLetterQueue? sqs.DeadLetterQueue Returns an instance of the DeadLetterQueue 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

API Gateway Request/Response Template Properties Overview

This construct allows you to implement four DynamoDB API operations, CREATE/READ/DELETE (corresponding the HTTP POST/GET/DELETE requests respectively). They are completely independent and each follows the same pattern:

  • Setting allowCreateOperation to true will implement the application/json content-type with default request and response templates
  • The request template for application/json requests can be customized using the createRequestTemplate prop value
  • Additional request templates can be specified using the additionalCreateRequestTemplates prop value. Note - these DO NOT replace the application/json content-type
  • Customized integration responses can be specified for any content type in the createIntegrationResponses prop value.

Supplying any of these values without setting allowCreateOperation to true will result in an error. This pattern is the same for all four API operations.

Default settings

Out of the box implementation of the Construct without any override 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
  • Enable X-Ray Tracing

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

Architecture Diagram


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

Package Sidebar

Install

npm i @aws-solutions-constructs/aws-apigateway-sqs

Weekly Downloads

2,412

Version

2.55.0

License

Apache-2.0

Unpacked Size

704 kB

Total Files

60

Last publish

Collaborators

  • aws-solutions-constructs-team