Security News
New Proposed CISA Mandate Would Require Critical Infrastructure to Report Ransom Payments Within 24 Hours
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
@aws-solutions-constructs/aws-apigateway-sqs
Advanced tools
CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.
Weekly downloads
Readme
Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_apigateway_sqs |
Typescript | @aws-solutions-constructs/aws-apigateway-sqs |
Java | software.amazon.awsconstructs.services.apigatewaysqs |
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());
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. |
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. |
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 |
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:
allowCreateOperation
to true will implement the application/json
content-type with default request and response templatesapplication/json
requests can be customized using the createRequestTemplate
prop valueadditionalCreateRequestTemplates
prop value. Note - these DO NOT replace the application/json
content-typecreateIntegrationResponses
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.
Out of the box implementation of the Construct without any override will set the following defaults:
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
FAQs
CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.
The npm package @aws-solutions-constructs/aws-apigateway-sqs receives a total of 1,976 weekly downloads. As such, @aws-solutions-constructs/aws-apigateway-sqs popularity was classified as popular.
We found that @aws-solutions-constructs/aws-apigateway-sqs demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA has proposed a set of new rules that would require critical infrastructure to report cyber incidents and ransom payments.
Security News
Redis is no longer OSS, breaking its explicit commitment to remain under the BSD 3-Clause License forever. This has angered contributors who are now working to fork the software.
Product
Socket AI now enables 'AI detected potential malware' alerts by default, ensuring users benefit from AI-powered state-of-the-art malware detection without needing to opt-in.