Metadata-Version: 2.1
Name: aws-solutions-konstruk.aws-apigateway-sqs
Version: 0.8.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-konstruk.git
Author: Amazon Web Services
License: Apache-2.0
Project-URL: Source, https://github.com/awslabs/aws-solutions-konstruk.git
Description: # aws-apigateway-sqs module
        
        <!--BEGIN STABILITY BANNER-->---
        
        
        ![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)
        
        > **This is a *developer preview* (public beta) module.**
        >
        > All classes are under active development and subject to non-backward compatible changes or removal in any
        > future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.
        > This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
        
        ---
        <!--END STABILITY BANNER-->
        
        | **API Reference**:| <span style="font-weight: normal">http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-apigateway-sqs/</span>|
        |:-------------|:-------------|
        
        <div style="height:8px"></div>
        
        | **Language**     | **Package**        |
        |:-------------|-----------------|
        |![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png){: style="height:16px;width:16px"} Python|`aws_solutions_konstruk.aws_apigateway_sqs`|
        |![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png){: style="height:16px;width:16px"} Typescript|`@aws-solutions-konstruk/aws-apigateway-sqs`|
        
        ## Overview
        
        This AWS Solutions Konstruk implements an Amazon API Gateway connected to an Amazon SQS queue pattern.
        
        Here is a minimal deployable pattern definition:
        
        ```javascript
        const { ApiGatewayToSqs } = require('@aws-solutions-konstruk/aws-apigateway-sqs');
        
        new ApiGatewayToSqs(stack, 'ApiGatewayToSqsPattern', {
            apiGatewayProps: {},
            queueProps: {},
            encryptionKeyProps: {},
            deployDeadLetterQueue?: true,
            maxReceiveCount?: 3
        });
        
        ```
        
        ## Initializer
        
        ```text
        new ApiGatewayToSqs(scope: Construct, id: string, props: ApiGatewayToSqsProps);
        ```
        
        *Parameters*
        
        * scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html)
        * id `string`
        * props [`ApiGatewayToSqsProps`](#pattern-construct-props)
        
        ## Pattern Construct Props
        
        | **Name**     | **Type**        | **Description** |
        |:-------------|:----------------|-----------------|
        |apiGatewayProps?|[`api.RestApiProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApiProps.html)|Optional user-provided props to override the default props for the API Gateway.|
        |queueProps?|[`sqs.QueueProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.QueueProps.html)|Optional user-provided props to override the default props for the queue.|
        |encryptionKeyProps?|[`kms.KeyProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-kms.KeyProps.html)|Optional user-provided props to override the default props for the encryption key.|
        |deployDeadLetterQueue|`boolean`|Whether to deploy a secondary queue to be used as a dead letter queue.|
        |maxReceiveCount|`number`|The number of times a message can be unsuccesfully dequeued before being moved to the dead-letter queue.|
        
        ## Pattern Properties
        
        | **Name**     | **Type**        | **Description** |
        |:-------------|:----------------|-----------------|
        |api()|[`api.RestApi`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|
        |sqsQueue()|[`sqs.Queue`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-sqs.Queue.html)|Returns an instance of the SQS queue 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|
        
        ## Architecture
        
        ![Architecture Diagram](architecture.png)
        
        ---
        
        
        © Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: JavaScript
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Typing :: Typed
Classifier: License :: OSI Approved
Requires-Python: >=3.6
Description-Content-Type: text/markdown
