Overview Pattern Construct Props Pattern Properties Sample API Usage API Gateway Request/Response Template Properties Overview Default settings Architecture GitHub

aws-apigateway-sqs

Two labels: "CFN-RESOURCES" in gray and "STABLE" in green.

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 Construct implements an Amazon API Gateway connected to an Amazon SQS queue pattern.

Here is a minimal deployable pattern definition:

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.
createMethodResponses?	`api.MethodResponses[]`	Optional, custom API Gateway Method Responses for the create action. default: [{ statusCode: "200", responseParameters: { "method.response.header.Content-Type": true }},{ statusCode: "500", responseParameters: { "method.response.header.Content-Type": 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.
readMethodResponses?	`api.MethodResponses[]`	Optional, custom API Gateway Method Responses for the read action. default: [{ statusCode: "200", responseParameters: { "method.response.header.Content-Type": true }},{ statusCode: "500", responseParameters: { "method.response.header.Content-Type": true } } ]
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.
deleteMethodResponses?	`api.MethodResponses[]`	Optional, custom API Gateway Method Responses for the delete action. default: [{ statusCode: "200", responseParameters: { "method.response.header.Content-Type": true }},{ statusCode: "500", responseParameters: { "method.response.header.Content-Type": 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.
messageSchema?	{ [contentType: string]: api.JsonSchema; }	Optional schema to define format of incoming message in API request body. Example: { "application/json": { schema: api.JsonSchemaVersion.DRAFT4, title: "pollResponse", type: api.JsonSchemaType.OBJECT, required: ["firstProperty", "antotherProperty"], additionalProperties: false, properties: { firstProperty: { type: api.JsonSchemaType.STRING }, antotherProperty: { type: api.JsonSchemaType.STRING } } } Only relevant for create operation, if allowCreateOperation is not true, then supplying this is an error. Sending this value causes this construct to turn on validation for the request body. @default - None

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.