# aws-apigatewayv2websocket-sqs module
<!--BEGIN STABILITY BANNER-->---
---
<!--END STABILITY BANNER-->
| **Reference Documentation**:| <span style="font-weight: normal">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|
|:-------------|:-------------|
<div style="height:8px"></div>
| **Language** | **Package** |
|:-------------|-----------------|
| Python|`aws_solutions_constructs.aws_apigatewayv2websocket_sqs`|
| Typescript|`@aws-solutions-constructs/aws-apigatewayv2websocket-sqs`|
| Java|`software.amazon.awsconstructs.services.apigatewayv2websocketsqs`|
## Overview
This AWS Solutions Construct implements an Amazon API Gateway WebSocket connected to an Amazon SQS queue pattern.
Here is a minimal deployable pattern definition:
Typescript
```python
import { Construct } from "constructs";
import { Stack, StackProps } from "aws-cdk-lib";
import {
ApiGatewayV2WebSocketToSqs,
ApiGatewayV2WebSocketToSqsProps,
} from "@aws-solutions-constructs/aws-apigatewayv2websocket-sqs";
import { WebSocketLambdaAuthorizer } from 'aws-cdk-lib/aws-apigatewayv2-authorizers';
const authorizer = new WebSocketLambdaAuthorizer('Authorizer', authHandler);
new ApiGateApiGatewayV2WebSocketToSqswayToSqs(this, "ApiGatewayV2WebSocketToSqsPattern", {
webSocketApiProps: {
connectRouteOptions: {
integration: new WebSocketLambdaIntegration("ConnectIntegration", connectLambda),
authorizer: authorizer,
},
disconnectRouteOptions: {
integration: new WebSocketLambdaIntegration("DisconnectIntegration", disconnectLambda),
},
},
createDefaultRoute: true
});
```
Python
```python
from aws_solutions_constructs.aws_apigateway_sqs import ApiGatewayV2WebSocketToSqs
from aws_cdk.aws_apigatewayv2_authorizers import WebSocketLambdaAuthorizer
from aws_cdk import Stack
from constructs import Construct
authorizer = WebSocketLambdaAuthorizer("Authorizer", auth_handler)
ApiGatewayV2WebSocketToSqs(self, 'ApiGatewayV2WebSocketToSqsPattern',
connect_route_options=apigwv2.WebSocketRouteOptions(
integration=WebSocketLambdaIntegration("ConnectIntegration", connect_lambda),
authorizer=authorizer
),
disconnect_route_options=apigwv2.WebSocketRouteOptions(
integration=WebSocketLambdaIntegration("DisConnectIntegration", disconnect_lambda),
),
create_default_route=True
)
```
Java
```java
import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.aws_apigatewayv2_authorizers.*;
import software.amazon.awscdk.aws_apigatewayv2_integrations.*;
import software.amazon.awsconstructs.services.apigatewaysqs.*;
new ApiGatewayV2WebSocketToSqs(this, "ApiGatewayV2WebSocketToSqsPattern", new ApiGatewayV2WebSocketToSqsProps.Builder()
.webSocketApiProps(new WebSocketApiProps.Builder()
.connectRouteOptions(new WebSocketRouteOptions.builder()
.integration(new WebSocketLambdaIntegration("ConnectIntegration", connect_lambda)))
.disconnectRouteOptions(new WebSocketRouteOptions.builder()
.integration(new WebSocketLambdaIntegration("DisConnectIntegration", disconnect_lambda)))
.createDefaultRoute(true)
.build());
```
## Pattern Construct Props
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|existingWebSocketApi?|[`apigwv2.WebSocketApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApi.html)|Optional API Gateway WebSocket instance. Providing both existingWebSocketApi and webSocketApiProps will cause an error.|
|webSocketApiProps?|[`apigwv2.WebSocketApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApiProps.html)|Optional user-provided props to override the default props for the API Gateway. Providing both existingWebSocketApi and webSocketApiProps will cause an error.|
|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the queue. Providing both existingQueueObj and queueProps will cause an error.|
|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Optional existing instance of SQS Queue. Providing both existingQueueObj and queueProps will cause an error.|
|deployDeadLetterQueue?|`boolean`|Whether to deploy a secondary queue to be used as a dead letter queue. Defaults to `true`.|
|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional properties to use for creating dead letter queue. Note that if you are creating a FIFO Queue, the dead letter queue should also be FIFO.|
|maxReceiveCount|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.|
|createDefaultRoute?|`boolean`|Whether to create a default route. At least one of createDefaultRoute or customRouteName must be provided. If set to true, then it will use the value supplied with `defaultRouteRequestTemplate`.|
|defaultRouteRequestTemplate?|`{ [contentType: string]: string }`|Optional user provided API Gateway Request Template for the default route and/ or customRoute (if customRouteName is provided). This property will only be used if createDefaultRoute is `true`. If createDefaultRoute is `true` and this property is not provided, the construct will create the default route with the following VTL mapping `"Action=SendMessage&MessageGroupId=$input.path('$.MessageGroupId')&MessageDeduplicationId=$context.requestId&MessageAttribute.1.Name=connectionId&MessageAttribute.1.Value.StringValue=$context.connectionId&MessageAttribute.1.Value.DataType=String&MessageAttribute.2.Name=requestId&MessageAttribute.2.Value.StringValue=$context.requestId&MessageAttribute.2.Value.DataType=String&MessageBody=$util.urlEncode($input.json($util.escapeJavaScript('$').replaceAll(\"\\\\'\",\"'\")))"`.|
|defaultIamAuthorization?|`boolean`|Add IAM authorization to the $connect path by default. Only set this to false if: 1) If plan to provide an authorizer with the `$connect` route; or 2) The API should be open (no authorization) (AWS recommends against deploying unprotected APIs). If an authorizer is specified in connectRouteOptions, this parameter is ignored and no default IAM authorizer will be created. |
|customRouteName?|`string`|The name of the route that will be sent through WebSocketApiProps.routeSelectionExpression when invoking the WebSocket endpoint. At least one of createDefaultRoute or customRouteName must be provided. |
## Pattern Properties
| **Name** | **Type** | **Description** |
|:-------------|:----------------|-----------------|
|webSocketApi|[`apigwv2.WebSocketApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApi.html)|Returns an instance of the API Gateway WebSocket API created by the pattern.|
|apiGatewayRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway.|
|webSocketStage|[`apigwv2.WebSocketStage`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketStage.html)|Returns an instance of the WebSocketStage created by the construct.|
|apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|
|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the SQS queue created by the pattern.|
|deadLetterQueue?|[`sqs.DeadLetterQueue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.DeadLetterQueue.html)|Returns an instance of the DeadLetterQueue created by the pattern.|
## Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
### Amazon API Gateway
* Deploy a WebSocket endpoint
* Enable CloudWatch logging for API Gateway
* Configure least privilege access IAM role for API Gateway
* 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
---
© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
Raw data
{
"_id": null,
"home_page": "https://github.com/awslabs/aws-solutions-constructs.git",
"name": "aws-solutions-constructs.aws-apigatewayv2websocket-sqs",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Amazon Web Services",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1d/fb/fe32f10c7ad26bed7a636b3e9db6cd673d7ec8fdc294f7ee3c1ab87891dd/aws_solutions_constructs_aws_apigatewayv2websocket_sqs-2.74.0.tar.gz",
"platform": null,
"description": "# aws-apigatewayv2websocket-sqs module\n\n<!--BEGIN STABILITY BANNER-->---\n\n\n\n\n---\n<!--END STABILITY BANNER-->\n\n| **Reference Documentation**:| <span style=\"font-weight: normal\">https://docs.aws.amazon.com/solutions/latest/constructs/</span>|\n|:-------------|:-------------|\n\n<div style=\"height:8px\"></div>\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n| Python|`aws_solutions_constructs.aws_apigatewayv2websocket_sqs`|\n| Typescript|`@aws-solutions-constructs/aws-apigatewayv2websocket-sqs`|\n| Java|`software.amazon.awsconstructs.services.apigatewayv2websocketsqs`|\n\n## Overview\n\nThis AWS Solutions Construct implements an Amazon API Gateway WebSocket connected to an Amazon SQS queue pattern.\n\nHere is a minimal deployable pattern definition:\n\nTypescript\n\n```python\nimport { Construct } from \"constructs\";\nimport { Stack, StackProps } from \"aws-cdk-lib\";\nimport {\n\tApiGatewayV2WebSocketToSqs,\n\tApiGatewayV2WebSocketToSqsProps,\n} from \"@aws-solutions-constructs/aws-apigatewayv2websocket-sqs\";\nimport { WebSocketLambdaAuthorizer } from 'aws-cdk-lib/aws-apigatewayv2-authorizers';\n\nconst authorizer = new WebSocketLambdaAuthorizer('Authorizer', authHandler);\n\nnew ApiGateApiGatewayV2WebSocketToSqswayToSqs(this, \"ApiGatewayV2WebSocketToSqsPattern\", {\n\twebSocketApiProps: {\n\t\tconnectRouteOptions: {\n\t\t\tintegration: new WebSocketLambdaIntegration(\"ConnectIntegration\", connectLambda),\n\t\t\tauthorizer: authorizer,\n\t\t},\n\t\tdisconnectRouteOptions: {\n\t\t\tintegration: new WebSocketLambdaIntegration(\"DisconnectIntegration\", disconnectLambda),\n\t\t},\n\t},\n createDefaultRoute: true\n});\n```\n\nPython\n\n```python\nfrom aws_solutions_constructs.aws_apigateway_sqs import ApiGatewayV2WebSocketToSqs\nfrom aws_cdk.aws_apigatewayv2_authorizers import WebSocketLambdaAuthorizer\nfrom aws_cdk import Stack\nfrom constructs import Construct\n\nauthorizer = WebSocketLambdaAuthorizer(\"Authorizer\", auth_handler)\n\nApiGatewayV2WebSocketToSqs(self, 'ApiGatewayV2WebSocketToSqsPattern',\n connect_route_options=apigwv2.WebSocketRouteOptions(\n integration=WebSocketLambdaIntegration(\"ConnectIntegration\", connect_lambda),\n authorizer=authorizer\n ),\n disconnect_route_options=apigwv2.WebSocketRouteOptions(\n integration=WebSocketLambdaIntegration(\"DisConnectIntegration\", disconnect_lambda),\n ),\n create_default_route=True\n)\n```\n\nJava\n\n```java\nimport software.constructs.Construct;\n\nimport software.amazon.awscdk.Stack;\nimport software.amazon.awscdk.StackProps;\nimport software.amazon.awscdk.aws_apigatewayv2_authorizers.*;\nimport software.amazon.awscdk.aws_apigatewayv2_integrations.*;\nimport software.amazon.awsconstructs.services.apigatewaysqs.*;\n\nnew ApiGatewayV2WebSocketToSqs(this, \"ApiGatewayV2WebSocketToSqsPattern\", new ApiGatewayV2WebSocketToSqsProps.Builder()\n .webSocketApiProps(new WebSocketApiProps.Builder()\n .connectRouteOptions(new WebSocketRouteOptions.builder()\n .integration(new WebSocketLambdaIntegration(\"ConnectIntegration\", connect_lambda)))\n .disconnectRouteOptions(new WebSocketRouteOptions.builder()\n .integration(new WebSocketLambdaIntegration(\"DisConnectIntegration\", disconnect_lambda)))\n .createDefaultRoute(true)\n .build());\n```\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|existingWebSocketApi?|[`apigwv2.WebSocketApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApi.html)|Optional API Gateway WebSocket instance. Providing both existingWebSocketApi and webSocketApiProps will cause an error.|\n|webSocketApiProps?|[`apigwv2.WebSocketApiProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApiProps.html)|Optional user-provided props to override the default props for the API Gateway. Providing both existingWebSocketApi and webSocketApiProps will cause an error.|\n|queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional user-provided props to override the default props for the queue. Providing both existingQueueObj and queueProps will cause an error.|\n|existingQueueObj?|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Optional existing instance of SQS Queue. Providing both existingQueueObj and queueProps will cause an error.|\n|deployDeadLetterQueue?|`boolean`|Whether to deploy a secondary queue to be used as a dead letter queue. Defaults to `true`.|\n|deadLetterQueueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.QueueProps.html)|Optional properties to use for creating dead letter queue. Note that if you are creating a FIFO Queue, the dead letter queue should also be FIFO.|\n|maxReceiveCount|`number`|The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.|\n|createDefaultRoute?|`boolean`|Whether to create a default route. At least one of createDefaultRoute or customRouteName must be provided. If set to true, then it will use the value supplied with `defaultRouteRequestTemplate`.|\n|defaultRouteRequestTemplate?|`{ [contentType: string]: string }`|Optional user provided API Gateway Request Template for the default route and/ or customRoute (if customRouteName is provided). This property will only be used if createDefaultRoute is `true`. If createDefaultRoute is `true` and this property is not provided, the construct will create the default route with the following VTL mapping `\"Action=SendMessage&MessageGroupId=$input.path('$.MessageGroupId')&MessageDeduplicationId=$context.requestId&MessageAttribute.1.Name=connectionId&MessageAttribute.1.Value.StringValue=$context.connectionId&MessageAttribute.1.Value.DataType=String&MessageAttribute.2.Name=requestId&MessageAttribute.2.Value.StringValue=$context.requestId&MessageAttribute.2.Value.DataType=String&MessageBody=$util.urlEncode($input.json($util.escapeJavaScript('$').replaceAll(\\\"\\\\\\\\'\\\",\\\"'\\\")))\"`.|\n|defaultIamAuthorization?|`boolean`|Add IAM authorization to the $connect path by default. Only set this to false if: 1) If plan to provide an authorizer with the `$connect` route; or 2) The API should be open (no authorization) (AWS recommends against deploying unprotected APIs). If an authorizer is specified in connectRouteOptions, this parameter is ignored and no default IAM authorizer will be created. |\n|customRouteName?|`string`|The name of the route that will be sent through WebSocketApiProps.routeSelectionExpression when invoking the WebSocket endpoint. At least one of createDefaultRoute or customRouteName must be provided. |\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|webSocketApi|[`apigwv2.WebSocketApi`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketApi.html)|Returns an instance of the API Gateway WebSocket API created by the pattern.|\n|apiGatewayRole|[`iam.Role`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_iam.Role.html)|Returns an instance of the iam.Role created by the construct for API Gateway.|\n|webSocketStage|[`apigwv2.WebSocketStage`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_apigatewayv2.WebSocketStage.html)|Returns an instance of the WebSocketStage created by the construct.|\n|apiGatewayLogGroup|[`logs.LogGroup`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_logs.LogGroup.html)|Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.|\n|sqsQueue|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.Queue.html)|Returns an instance of the SQS queue created by the pattern.|\n|deadLetterQueue?|[`sqs.DeadLetterQueue`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_sqs.DeadLetterQueue.html)|Returns an instance of the DeadLetterQueue created by the pattern.|\n\n## Default settings\n\nOut of the box implementation of the Construct without any override will set the following defaults:\n\n### Amazon API Gateway\n\n* Deploy a WebSocket endpoint\n* Enable CloudWatch logging for API Gateway\n* Configure least privilege access IAM role for API Gateway\n* Enable X-Ray Tracing\n\n### Amazon SQS Queue\n\n* Deploy SQS dead-letter queue for the source SQS Queue\n* Enable server-side encryption for source SQS Queue using AWS Managed KMS Key\n* Enforce encryption of data in transit\n\n## Architecture\n\n\n\n---\n\n\n\u00a9 Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.",
"version": "2.74.0",
"project_urls": {
"Homepage": "https://github.com/awslabs/aws-solutions-constructs.git",
"Source": "https://github.com/awslabs/aws-solutions-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a991c934fb5d3d14dc1036cf3836530ba2dd0f0b81202d5ce12e528c97b872ab",
"md5": "3cbfef6d605463f84bd127b488d2b053",
"sha256": "32d2aaa858fed5ebf29a12c8da414bb98ab125e39fffba00c53502f90fdfcee4"
},
"downloads": -1,
"filename": "aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.74.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3cbfef6d605463f84bd127b488d2b053",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 210176,
"upload_time": "2024-10-22T18:07:18",
"upload_time_iso_8601": "2024-10-22T18:07:18.297403Z",
"url": "https://files.pythonhosted.org/packages/a9/91/c934fb5d3d14dc1036cf3836530ba2dd0f0b81202d5ce12e528c97b872ab/aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.74.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1dfbfe32f10c7ad26bed7a636b3e9db6cd673d7ec8fdc294f7ee3c1ab87891dd",
"md5": "19d9e26ee9e6082eb86ae5ed5c26aad1",
"sha256": "06eb705dd888ecd168e9fbbf84b7ba372cf64f38340c4adcf188b9b7250251f8"
},
"downloads": -1,
"filename": "aws_solutions_constructs_aws_apigatewayv2websocket_sqs-2.74.0.tar.gz",
"has_sig": false,
"md5_digest": "19d9e26ee9e6082eb86ae5ed5c26aad1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 211783,
"upload_time": "2024-10-22T18:09:08",
"upload_time_iso_8601": "2024-10-22T18:09:08.689247Z",
"url": "https://files.pythonhosted.org/packages/1d/fb/fe32f10c7ad26bed7a636b3e9db6cd673d7ec8fdc294f7ee3c1ab87891dd/aws_solutions_constructs_aws_apigatewayv2websocket_sqs-2.74.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-22 18:09:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "awslabs",
"github_project": "aws-solutions-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aws-solutions-constructs.aws-apigatewayv2websocket-sqs"
}
JSON
