aws-solutions-constructs.aws-apigatewayv2websocket-sqs 2.63.0__py3-none-any.whl

aws_solutions_constructs/aws_apigatewayv2websocket_sqs/__init__.py

@@ -0,0 +1,615 @@
+r'''
+# aws-apigatewayv2websocket-sqs module
+
+<!--BEGIN STABILITY BANNER-->---
+
+
+![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
+
+---
+<!--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 Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigatewayv2websocket_sqs`|
+|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigatewayv2websocket-sqs`|
+|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) 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
+
+![Architecture Diagram](architecture.png)
+
+---
+
+
+© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+'''
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
+import abc
+import builtins
+import datetime
+import enum
+import typing
+
+import jsii
+import publication
+import typing_extensions
+
+from typeguard import check_type
+
+from ._jsii import *
+
+import aws_cdk.aws_apigatewayv2 as _aws_cdk_aws_apigatewayv2_ceddda9d
+import aws_cdk.aws_iam as _aws_cdk_aws_iam_ceddda9d
+import aws_cdk.aws_kms as _aws_cdk_aws_kms_ceddda9d
+import aws_cdk.aws_logs as _aws_cdk_aws_logs_ceddda9d
+import aws_cdk.aws_sqs as _aws_cdk_aws_sqs_ceddda9d
+import constructs as _constructs_77d1e7e8
+
+
+class ApiGatewayV2WebSocketToSqs(
+    _constructs_77d1e7e8.Construct,
+    metaclass=jsii.JSIIMeta,
+    jsii_type="@aws-solutions-constructs/aws-apigatewayv2websocket-sqs.ApiGatewayV2WebSocketToSqs",
+):
+    def __init__(
+        self,
+        scope: _constructs_77d1e7e8.Construct,
+        id: builtins.str,
+        *,
+        create_default_route: typing.Optional[builtins.bool] = None,
+        custom_route_name: typing.Optional[builtins.str] = None,
+        dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        default_iam_authorization: typing.Optional[builtins.bool] = None,
+        default_route_request_template: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
+        deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+        enable_encryption_with_customer_managed_key: typing.Optional[builtins.bool] = None,
+        encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+        encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+        existing_web_socket_api: typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi] = None,
+        log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        max_receive_count: typing.Optional[jsii.Number] = None,
+        queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        web_socket_api_props: typing.Optional[typing.Union[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    ) -> None:
+        '''
+        :param scope: -
+        :param id: -
+        :param create_default_route: Whether to create a $default route. If set to true, then it will use the value supplied with ``defaultRouteRequestTemplate``. At least one of createDefaultRoute or customRouteName must be provided. Default: - false.
+        :param custom_route_name: 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. Default: - None
+        :param dead_letter_queue_props: Optional user provided properties for the dead letter queue. Default: - Default props are used
+        :param default_iam_authorization: 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 Default: - true
+        :param default_route_request_template: Optional user provided API Gateway Request Template for the $default route or customRoute (if customRouteName is provided). Default: - construct will create and assign a template with default settings to send messages to Queue.
+        :param deploy_dead_letter_queue: Whether to deploy a secondary queue to be used as a dead letter queue. Default: - required field.
+        :param enable_encryption_with_customer_managed_key: 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. Default: - False if queueProps.encryptionMasterKey, encryptionKey, and encryptionKeyProps are all undefined.
+        :param encryption_key: An optional, imported encryption key to encrypt the SQS Queue with. Default: - None
+        :param encryption_key_props: Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with. Default: - None
+        :param existing_queue_obj: Existing instance of SQS queue object, providing both this and queueProps will cause an error.
+        :param existing_web_socket_api: Existing instance of WebSocket API object, providing both this and webSocketApiProps will cause an error. Default: - None
+        :param log_group_props: Optional user-provided props to override the default props for the log group. Default: - Default props are used
+        :param max_receive_count: The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. Default: - required only if deployDeadLetterQueue = true.
+        :param queue_props: User provided props to override the default props for the SQS queue. Default: - Default props are used
+        :param web_socket_api_props: Optional user-provided props to override the default props for the API Gateway. Default: - Default properties are used.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__f37fa6f73e46f6d9868a3a3fba942695c1871f3e14ca3f0c156d343212d4393e)
+            check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
+            check_type(argname="argument id", value=id, expected_type=type_hints["id"])
+        props = ApiGatewayV2WebSocketToSqsProps(
+            create_default_route=create_default_route,
+            custom_route_name=custom_route_name,
+            dead_letter_queue_props=dead_letter_queue_props,
+            default_iam_authorization=default_iam_authorization,
+            default_route_request_template=default_route_request_template,
+            deploy_dead_letter_queue=deploy_dead_letter_queue,
+            enable_encryption_with_customer_managed_key=enable_encryption_with_customer_managed_key,
+            encryption_key=encryption_key,
+            encryption_key_props=encryption_key_props,
+            existing_queue_obj=existing_queue_obj,
+            existing_web_socket_api=existing_web_socket_api,
+            log_group_props=log_group_props,
+            max_receive_count=max_receive_count,
+            queue_props=queue_props,
+            web_socket_api_props=web_socket_api_props,
+        )
+
+        jsii.create(self.__class__, self, [scope, id, props])
+
+    @builtins.property
+    @jsii.member(jsii_name="apiGatewayLogGroup")
+    def api_gateway_log_group(self) -> _aws_cdk_aws_logs_ceddda9d.LogGroup:
+        return typing.cast(_aws_cdk_aws_logs_ceddda9d.LogGroup, jsii.get(self, "apiGatewayLogGroup"))
+
+    @builtins.property
+    @jsii.member(jsii_name="apiGatewayRole")
+    def api_gateway_role(self) -> _aws_cdk_aws_iam_ceddda9d.Role:
+        return typing.cast(_aws_cdk_aws_iam_ceddda9d.Role, jsii.get(self, "apiGatewayRole"))
+
+    @builtins.property
+    @jsii.member(jsii_name="sqsQueue")
+    def sqs_queue(self) -> _aws_cdk_aws_sqs_ceddda9d.Queue:
+        return typing.cast(_aws_cdk_aws_sqs_ceddda9d.Queue, jsii.get(self, "sqsQueue"))
+
+    @builtins.property
+    @jsii.member(jsii_name="webSocketApi")
+    def web_socket_api(self) -> _aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi:
+        return typing.cast(_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi, jsii.get(self, "webSocketApi"))
+
+    @builtins.property
+    @jsii.member(jsii_name="webSocketStage")
+    def web_socket_stage(self) -> _aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketStage:
+        return typing.cast(_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketStage, jsii.get(self, "webSocketStage"))
+
+    @builtins.property
+    @jsii.member(jsii_name="deadLetterQueue")
+    def dead_letter_queue(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.DeadLetterQueue]:
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.DeadLetterQueue], jsii.get(self, "deadLetterQueue"))
+
+
+@jsii.data_type(
+    jsii_type="@aws-solutions-constructs/aws-apigatewayv2websocket-sqs.ApiGatewayV2WebSocketToSqsProps",
+    jsii_struct_bases=[],
+    name_mapping={
+        "create_default_route": "createDefaultRoute",
+        "custom_route_name": "customRouteName",
+        "dead_letter_queue_props": "deadLetterQueueProps",
+        "default_iam_authorization": "defaultIamAuthorization",
+        "default_route_request_template": "defaultRouteRequestTemplate",
+        "deploy_dead_letter_queue": "deployDeadLetterQueue",
+        "enable_encryption_with_customer_managed_key": "enableEncryptionWithCustomerManagedKey",
+        "encryption_key": "encryptionKey",
+        "encryption_key_props": "encryptionKeyProps",
+        "existing_queue_obj": "existingQueueObj",
+        "existing_web_socket_api": "existingWebSocketApi",
+        "log_group_props": "logGroupProps",
+        "max_receive_count": "maxReceiveCount",
+        "queue_props": "queueProps",
+        "web_socket_api_props": "webSocketApiProps",
+    },
+)
+class ApiGatewayV2WebSocketToSqsProps:
+    def __init__(
+        self,
+        *,
+        create_default_route: typing.Optional[builtins.bool] = None,
+        custom_route_name: typing.Optional[builtins.str] = None,
+        dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        default_iam_authorization: typing.Optional[builtins.bool] = None,
+        default_route_request_template: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
+        deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+        enable_encryption_with_customer_managed_key: typing.Optional[builtins.bool] = None,
+        encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+        encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+        existing_web_socket_api: typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi] = None,
+        log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        max_receive_count: typing.Optional[jsii.Number] = None,
+        queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+        web_socket_api_props: typing.Optional[typing.Union[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    ) -> None:
+        '''
+        :param create_default_route: Whether to create a $default route. If set to true, then it will use the value supplied with ``defaultRouteRequestTemplate``. At least one of createDefaultRoute or customRouteName must be provided. Default: - false.
+        :param custom_route_name: 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. Default: - None
+        :param dead_letter_queue_props: Optional user provided properties for the dead letter queue. Default: - Default props are used
+        :param default_iam_authorization: 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 Default: - true
+        :param default_route_request_template: Optional user provided API Gateway Request Template for the $default route or customRoute (if customRouteName is provided). Default: - construct will create and assign a template with default settings to send messages to Queue.
+        :param deploy_dead_letter_queue: Whether to deploy a secondary queue to be used as a dead letter queue. Default: - required field.
+        :param enable_encryption_with_customer_managed_key: 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. Default: - False if queueProps.encryptionMasterKey, encryptionKey, and encryptionKeyProps are all undefined.
+        :param encryption_key: An optional, imported encryption key to encrypt the SQS Queue with. Default: - None
+        :param encryption_key_props: Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with. Default: - None
+        :param existing_queue_obj: Existing instance of SQS queue object, providing both this and queueProps will cause an error.
+        :param existing_web_socket_api: Existing instance of WebSocket API object, providing both this and webSocketApiProps will cause an error. Default: - None
+        :param log_group_props: Optional user-provided props to override the default props for the log group. Default: - Default props are used
+        :param max_receive_count: The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue. Default: - required only if deployDeadLetterQueue = true.
+        :param queue_props: User provided props to override the default props for the SQS queue. Default: - Default props are used
+        :param web_socket_api_props: Optional user-provided props to override the default props for the API Gateway. Default: - Default properties are used.
+
+        :summary: The properties for the ApiGatewayV2WebSocketToSqs class.
+        '''
+        if isinstance(dead_letter_queue_props, dict):
+            dead_letter_queue_props = _aws_cdk_aws_sqs_ceddda9d.QueueProps(**dead_letter_queue_props)
+        if isinstance(encryption_key_props, dict):
+            encryption_key_props = _aws_cdk_aws_kms_ceddda9d.KeyProps(**encryption_key_props)
+        if isinstance(log_group_props, dict):
+            log_group_props = _aws_cdk_aws_logs_ceddda9d.LogGroupProps(**log_group_props)
+        if isinstance(queue_props, dict):
+            queue_props = _aws_cdk_aws_sqs_ceddda9d.QueueProps(**queue_props)
+        if isinstance(web_socket_api_props, dict):
+            web_socket_api_props = _aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps(**web_socket_api_props)
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__b07a17aaa5507b1179984f079be450d3b362ed1531e33a497ba2c57b2236c6f7)
+            check_type(argname="argument create_default_route", value=create_default_route, expected_type=type_hints["create_default_route"])
+            check_type(argname="argument custom_route_name", value=custom_route_name, expected_type=type_hints["custom_route_name"])
+            check_type(argname="argument dead_letter_queue_props", value=dead_letter_queue_props, expected_type=type_hints["dead_letter_queue_props"])
+            check_type(argname="argument default_iam_authorization", value=default_iam_authorization, expected_type=type_hints["default_iam_authorization"])
+            check_type(argname="argument default_route_request_template", value=default_route_request_template, expected_type=type_hints["default_route_request_template"])
+            check_type(argname="argument deploy_dead_letter_queue", value=deploy_dead_letter_queue, expected_type=type_hints["deploy_dead_letter_queue"])
+            check_type(argname="argument enable_encryption_with_customer_managed_key", value=enable_encryption_with_customer_managed_key, expected_type=type_hints["enable_encryption_with_customer_managed_key"])
+            check_type(argname="argument encryption_key", value=encryption_key, expected_type=type_hints["encryption_key"])
+            check_type(argname="argument encryption_key_props", value=encryption_key_props, expected_type=type_hints["encryption_key_props"])
+            check_type(argname="argument existing_queue_obj", value=existing_queue_obj, expected_type=type_hints["existing_queue_obj"])
+            check_type(argname="argument existing_web_socket_api", value=existing_web_socket_api, expected_type=type_hints["existing_web_socket_api"])
+            check_type(argname="argument log_group_props", value=log_group_props, expected_type=type_hints["log_group_props"])
+            check_type(argname="argument max_receive_count", value=max_receive_count, expected_type=type_hints["max_receive_count"])
+            check_type(argname="argument queue_props", value=queue_props, expected_type=type_hints["queue_props"])
+            check_type(argname="argument web_socket_api_props", value=web_socket_api_props, expected_type=type_hints["web_socket_api_props"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {}
+        if create_default_route is not None:
+            self._values["create_default_route"] = create_default_route
+        if custom_route_name is not None:
+            self._values["custom_route_name"] = custom_route_name
+        if dead_letter_queue_props is not None:
+            self._values["dead_letter_queue_props"] = dead_letter_queue_props
+        if default_iam_authorization is not None:
+            self._values["default_iam_authorization"] = default_iam_authorization
+        if default_route_request_template is not None:
+            self._values["default_route_request_template"] = default_route_request_template
+        if deploy_dead_letter_queue is not None:
+            self._values["deploy_dead_letter_queue"] = deploy_dead_letter_queue
+        if enable_encryption_with_customer_managed_key is not None:
+            self._values["enable_encryption_with_customer_managed_key"] = enable_encryption_with_customer_managed_key
+        if encryption_key is not None:
+            self._values["encryption_key"] = encryption_key
+        if encryption_key_props is not None:
+            self._values["encryption_key_props"] = encryption_key_props
+        if existing_queue_obj is not None:
+            self._values["existing_queue_obj"] = existing_queue_obj
+        if existing_web_socket_api is not None:
+            self._values["existing_web_socket_api"] = existing_web_socket_api
+        if log_group_props is not None:
+            self._values["log_group_props"] = log_group_props
+        if max_receive_count is not None:
+            self._values["max_receive_count"] = max_receive_count
+        if queue_props is not None:
+            self._values["queue_props"] = queue_props
+        if web_socket_api_props is not None:
+            self._values["web_socket_api_props"] = web_socket_api_props
+
+    @builtins.property
+    def create_default_route(self) -> typing.Optional[builtins.bool]:
+        '''Whether to create a $default route.
+
+        If set to true, then it will use the value supplied with ``defaultRouteRequestTemplate``.
+        At least one of createDefaultRoute or customRouteName must be provided.
+
+        :default: - false.
+        '''
+        result = self._values.get("create_default_route")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def custom_route_name(self) -> typing.Optional[builtins.str]:
+        '''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.
+
+        :default: - None
+        '''
+        result = self._values.get("custom_route_name")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    @builtins.property
+    def dead_letter_queue_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps]:
+        '''Optional user provided properties for the dead letter queue.
+
+        :default: - Default props are used
+        '''
+        result = self._values.get("dead_letter_queue_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps], result)
+
+    @builtins.property
+    def default_iam_authorization(self) -> typing.Optional[builtins.bool]:
+        '''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
+
+        :default: - true
+        '''
+        result = self._values.get("default_iam_authorization")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def default_route_request_template(
+        self,
+    ) -> typing.Optional[typing.Mapping[builtins.str, builtins.str]]:
+        '''Optional user provided API Gateway Request Template for the $default route or customRoute (if customRouteName is provided).
+
+        :default: - construct will create and assign a template with default settings to send messages to Queue.
+        '''
+        result = self._values.get("default_route_request_template")
+        return typing.cast(typing.Optional[typing.Mapping[builtins.str, builtins.str]], result)
+
+    @builtins.property
+    def deploy_dead_letter_queue(self) -> typing.Optional[builtins.bool]:
+        '''Whether to deploy a secondary queue to be used as a dead letter queue.
+
+        :default: - required field.
+        '''
+        result = self._values.get("deploy_dead_letter_queue")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def enable_encryption_with_customer_managed_key(
+        self,
+    ) -> typing.Optional[builtins.bool]:
+        '''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.
+
+        :default: - False if queueProps.encryptionMasterKey, encryptionKey, and encryptionKeyProps are all undefined.
+        '''
+        result = self._values.get("enable_encryption_with_customer_managed_key")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
+    @builtins.property
+    def encryption_key(self) -> typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key]:
+        '''An optional, imported encryption key to encrypt the SQS Queue with.
+
+        :default: - None
+        '''
+        result = self._values.get("encryption_key")
+        return typing.cast(typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key], result)
+
+    @builtins.property
+    def encryption_key_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_kms_ceddda9d.KeyProps]:
+        '''Optional user provided properties to override the default properties for the KMS encryption key used to encrypt the SQS queue with.
+
+        :default: - None
+        '''
+        result = self._values.get("encryption_key_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_kms_ceddda9d.KeyProps], result)
+
+    @builtins.property
+    def existing_queue_obj(self) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue]:
+        '''Existing instance of SQS queue object, providing both this  and queueProps will cause an error.'''
+        result = self._values.get("existing_queue_obj")
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue], result)
+
+    @builtins.property
+    def existing_web_socket_api(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi]:
+        '''Existing instance of WebSocket API object, providing both this and webSocketApiProps will cause an error.
+
+        :default: - None
+        '''
+        result = self._values.get("existing_web_socket_api")
+        return typing.cast(typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi], result)
+
+    @builtins.property
+    def log_group_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_logs_ceddda9d.LogGroupProps]:
+        '''Optional user-provided props to override the default props for the log group.
+
+        :default: - Default props are used
+        '''
+        result = self._values.get("log_group_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_logs_ceddda9d.LogGroupProps], result)
+
+    @builtins.property
+    def max_receive_count(self) -> typing.Optional[jsii.Number]:
+        '''The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
+
+        :default: - required only if deployDeadLetterQueue = true.
+        '''
+        result = self._values.get("max_receive_count")
+        return typing.cast(typing.Optional[jsii.Number], result)
+
+    @builtins.property
+    def queue_props(self) -> typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps]:
+        '''User provided props to override the default props for the SQS queue.
+
+        :default: - Default props are used
+        '''
+        result = self._values.get("queue_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_sqs_ceddda9d.QueueProps], result)
+
+    @builtins.property
+    def web_socket_api_props(
+        self,
+    ) -> typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps]:
+        '''Optional user-provided props to override the default props for the API Gateway.
+
+        :default: - Default properties are used.
+        '''
+        result = self._values.get("web_socket_api_props")
+        return typing.cast(typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "ApiGatewayV2WebSocketToSqsProps(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
+
+__all__ = [
+    "ApiGatewayV2WebSocketToSqs",
+    "ApiGatewayV2WebSocketToSqsProps",
+]
+
+publication.publish()
+
+def _typecheckingstub__f37fa6f73e46f6d9868a3a3fba942695c1871f3e14ca3f0c156d343212d4393e(
+    scope: _constructs_77d1e7e8.Construct,
+    id: builtins.str,
+    *,
+    create_default_route: typing.Optional[builtins.bool] = None,
+    custom_route_name: typing.Optional[builtins.str] = None,
+    dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    default_iam_authorization: typing.Optional[builtins.bool] = None,
+    default_route_request_template: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
+    deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+    enable_encryption_with_customer_managed_key: typing.Optional[builtins.bool] = None,
+    encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+    encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+    existing_web_socket_api: typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi] = None,
+    log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    max_receive_count: typing.Optional[jsii.Number] = None,
+    queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    web_socket_api_props: typing.Optional[typing.Union[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps, typing.Dict[builtins.str, typing.Any]]] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__b07a17aaa5507b1179984f079be450d3b362ed1531e33a497ba2c57b2236c6f7(
+    *,
+    create_default_route: typing.Optional[builtins.bool] = None,
+    custom_route_name: typing.Optional[builtins.str] = None,
+    dead_letter_queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    default_iam_authorization: typing.Optional[builtins.bool] = None,
+    default_route_request_template: typing.Optional[typing.Mapping[builtins.str, builtins.str]] = None,
+    deploy_dead_letter_queue: typing.Optional[builtins.bool] = None,
+    enable_encryption_with_customer_managed_key: typing.Optional[builtins.bool] = None,
+    encryption_key: typing.Optional[_aws_cdk_aws_kms_ceddda9d.Key] = None,
+    encryption_key_props: typing.Optional[typing.Union[_aws_cdk_aws_kms_ceddda9d.KeyProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    existing_queue_obj: typing.Optional[_aws_cdk_aws_sqs_ceddda9d.Queue] = None,
+    existing_web_socket_api: typing.Optional[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApi] = None,
+    log_group_props: typing.Optional[typing.Union[_aws_cdk_aws_logs_ceddda9d.LogGroupProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    max_receive_count: typing.Optional[jsii.Number] = None,
+    queue_props: typing.Optional[typing.Union[_aws_cdk_aws_sqs_ceddda9d.QueueProps, typing.Dict[builtins.str, typing.Any]]] = None,
+    web_socket_api_props: typing.Optional[typing.Union[_aws_cdk_aws_apigatewayv2_ceddda9d.WebSocketApiProps, typing.Dict[builtins.str, typing.Any]]] = None,
+) -> None:
+    """Type checking stubs"""
+    pass

aws_solutions_constructs/aws_apigatewayv2websocket_sqs/_jsii/__init__.py

@@ -0,0 +1,32 @@
+from pkgutil import extend_path
+__path__ = extend_path(__path__, __name__)
+
+import abc
+import builtins
+import datetime
+import enum
+import typing
+
+import jsii
+import publication
+import typing_extensions
+
+from typeguard import check_type
+
+import aws_cdk._jsii
+import aws_cdk.integ_tests_alpha._jsii
+import aws_solutions_constructs.core._jsii
+import constructs._jsii
+
+__jsii_assembly__ = jsii.JSIIAssembly.load(
+    "@aws-solutions-constructs/aws-apigatewayv2websocket-sqs",
+    "2.63.0",
+    __name__[0:-6],
+    "aws-apigatewayv2websocket-sqs@2.63.0.jsii.tgz",
+)
+
+__all__ = [
+    "__jsii_assembly__",
+]
+
+publication.publish()

aws_solutions_constructs/aws_apigatewayv2websocket_sqs/py.typed

@@ -0,0 +1 @@
+

aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/LICENSE

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/METADATA

@@ -0,0 +1,178 @@
+Metadata-Version: 2.1
+Name: aws-solutions-constructs.aws-apigatewayv2websocket-sqs
+Version: 2.63.0
+Summary: CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.
+Home-page: https://github.com/awslabs/aws-solutions-constructs.git
+Author: Amazon Web Services
+License: Apache-2.0
+Project-URL: Source, https://github.com/awslabs/aws-solutions-constructs.git
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: JavaScript
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Typing :: Typed
+Classifier: License :: OSI Approved
+Requires-Python: ~=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aws-cdk-lib ==2.149.0
+Requires-Dist: aws-cdk.integ-tests-alpha ==2.149.0.a0
+Requires-Dist: aws-solutions-constructs.core ==2.63.0
+Requires-Dist: constructs <11.0.0,>=10.0.0
+Requires-Dist: jsii <2.0.0,>=1.101.0
+Requires-Dist: publication >=0.0.3
+Requires-Dist: typeguard ~=2.13.3
+
+# aws-apigatewayv2websocket-sqs module
+
+<!--BEGIN STABILITY BANNER-->---
+
+
+![Stability: Stable](https://img.shields.io/badge/cfn--resources-stable-success.svg?style=for-the-badge)
+
+---
+<!--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 Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png) Python|`aws_solutions_constructs.aws_apigatewayv2websocket_sqs`|
+|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png) Typescript|`@aws-solutions-constructs/aws-apigatewayv2websocket-sqs`|
+|![Java Logo](https://docs.aws.amazon.com/cdk/api/latest/img/java32.png) 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
+
+![Architecture Diagram](architecture.png)
+
+---
+
+
+© Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+aws_solutions_constructs/aws_apigatewayv2websocket_sqs/__init__.py,sha256=f75atSECKSKZ5wQcNQk2xLpz_-qy3SFx-mOWObfQX-0,39160
+aws_solutions_constructs/aws_apigatewayv2websocket_sqs/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+aws_solutions_constructs/aws_apigatewayv2websocket_sqs/_jsii/__init__.py,sha256=mnV4PomE65npOKwg3UXtivfN1EQMSuBVzLQyBlTXs18,624
+aws_solutions_constructs/aws_apigatewayv2websocket_sqs/_jsii/aws-apigatewayv2websocket-sqs@2.63.0.jsii.tgz,sha256=xzhIrAcJ3qtdzn278-LfmY5wI4wAvnKvRVRmeQasAYc,194336
+aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/LICENSE,sha256=wnT4A3LZDAEpNzcPDh8VCH0i4wjvmLJ86l3A0tCINmw,10279
+aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/METADATA,sha256=kB88XPbINtogfhI1UvzDYa64rxrxYuF8qI0uoxD7i2I,10280
+aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/top_level.txt,sha256=hi3us_KW7V1ocfOqVsNq1o3w552jCEgu_KsCckqYWsg,25
+aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/RECORD,,

aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.41.3)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

aws_solutions_constructs.aws_apigatewayv2websocket_sqs-2.63.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+aws_solutions_constructs