{"_id":"@aws-solutions-konstruk/aws-apigateway-sqs","_rev":"2-820bfd02c05bcfb3cd4922e1fef9e732","name":"@aws-solutions-konstruk/aws-apigateway-sqs","dist-tags":{"latest":"0.8.1"},"versions":{"0.8.0":{"name":"@aws-solutions-konstruk/aws-apigateway-sqs","version":"0.8.0","description":"CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.","main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/awslabs/aws-solutions-konstruk.git","directory":"source/patterns/@aws-solutions-konstruk/aws-apigateway-sqs"},"author":{"name":"Amazon Web Services","url":"https://aws.amazon.com"},"license":"Apache-2.0","scripts":{"build":"tsc -b .","lint":"eslint -c ../eslintrc.yml --ext=.js,.ts . && tslint --project .","lint-fix":"eslint -c ../eslintrc.yml --ext=.js,.ts --fix .","test":"jest --coverage","clean":"tsc -b --clean","watch":"tsc -b -w","integ":"cdk-integ","integ-assert":"cdk-integ-assert","jsii":"jsii","jsii-pacmak":"jsii-pacmak","build+lint+test":"npm run jsii && npm run lint && npm test && npm run integ-assert","snapshot-update":"npm run jsii && npm test -- -u && npm run integ-assert"},"jsii":{"outdir":"dist","targets":{"java":{"package":"software.amazon.konstruk.services.apigatewaysqs","maven":{"groupId":"software.amazon.konstruk","artifactId":"apigatewaysqs"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.ApiGatewaySqs","packageId":"Amazon.Konstruk.AWS.ApiGatewaySqs","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-apigateway-sqs","module":"aws_solutions_konstruk.aws_apigateway_sqs"}}},"dependencies":{"@aws-cdk/aws-apigateway":"~1.25.0","@aws-cdk/aws-sqs":"~1.25.0","@aws-cdk/aws-kms":"~1.25.0","@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-solutions-konstruk/core":"~0.8.0"},"devDependencies":{"@aws-cdk/assert":"~1.25.0","@types/jest":"^24.0.23","@types/node":"^10.3.0"},"jest":{"moduleFileExtensions":["js"]},"peerDependencies":{"@aws-cdk/aws-apigateway":"~1.25.0","@aws-cdk/aws-sqs":"~1.25.0","@aws-cdk/aws-kms":"~1.25.0","@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/core":"~1.25.0","@aws-solutions-konstruk/core":"~0.8.0"},"_resolved":"","_integrity":"","_from":"file:/codebuild/output/src873081847/src/deployment/publishing/npm/../../dist/js/aws-apigateway-sqs@0.8.0.jsii.tgz","bugs":{"url":"https://github.com/awslabs/aws-solutions-konstruk/issues"},"homepage":"https://github.com/awslabs/aws-solutions-konstruk#readme","_id":"@aws-solutions-konstruk/aws-apigateway-sqs@0.8.0","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-Ty8+D4INSY/zGHDv6kgmB2nJGVhCk3dyx8Ck0g0KYbY3f9U+eu9ByTlAzfBohIKGwIVVEN+jO4JpCgbX0+gDYg==","shasum":"e34d72759c499a94cb3daa0586dee9817330f891","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-apigateway-sqs/-/aws-apigateway-sqs-0.8.0.tgz","fileCount":16,"unpackedSize":285919,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefPYICRA9TVsSAnZWagAAhEwQAJ6rd3uQ/GKlBLV8AMTK\nxcSBcX8GiIR6gTtFvGToHVobIM2fVbLukjYMT4KAdyW7YxqIFJQEGabSKy3S\nTPo8IyLt5+we6xPnqst+G8WPiQk8Jh7fytQusCIGf6UoLZwdFQsqFhl1lY5F\nrpHroQu1yTGtUxg1+i0YUMfBSqT0dsbYDyATMvk1Kzvr6Wgu3nPcj96o2D4m\ncqrODrZR+T2WtLDU9f+spmYpFvGodWoT4JN60nlY/swK48HahmVEX99JL7KX\n6L0CsTuYochZdEdco8lRgJXcfmGO8ClxsP0jJZaFVvQ88NeH0MlYZ4n94PD+\naY2AXMjrJFsYloiNdpCg7WoTZs7XReIchVqyoCdtkDkBrCaiu7HpHnFBNgvQ\nlSreELErFQ8ja5gUvrTIqI4sD/j5osrFOaAKFwnu1Wh1LBJC7WHpMmR4y4mu\nO2IbpmgtGaXOIXH/Efhldob1M6/l0mLluY7yyxoE6BE/e6q8K3qZgMmH6E8Y\nnGDyHmQGMMAh2BZVXR338UjNwfFSJYexHBV27Ok3xU4W6ZM15MfoK+VEtxom\nla9dzzKsHWWT8e0Wv5CA7m/2jk8cKWVuqx1CqOtTQz8T7g2h/ovK0BADUmT1\nl92XZxDxljVsFsSOnrDEiBiGjODQeHEn1/dJD9wG4wL4lCBOVFKtvZQpAaSd\n5BOh\r\n=ibeH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA2mCzmoj9pg4Jh+AE8H80pErnuI9dj477ZAQN1FdmcNAiAahKUy0uT3FrE93wxwji7hcTAMPkaVdrPlBTfV8Swzvg=="}]},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"_npmUser":{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aws-apigateway-sqs_0.8.0_1585247752201_0.467132563218416"},"_hasShrinkwrap":false},"0.8.1":{"name":"@aws-solutions-konstruk/aws-apigateway-sqs","version":"0.8.1","description":"CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.","main":"lib/index.js","types":"lib/index.d.ts","repository":{"type":"git","url":"git+https://github.com/awslabs/aws-solutions-konstruk.git","directory":"source/patterns/@aws-solutions-konstruk/aws-apigateway-sqs"},"author":{"name":"Amazon Web Services","url":"https://aws.amazon.com"},"license":"Apache-2.0","scripts":{"build":"tsc -b .","lint":"eslint -c ../eslintrc.yml --ext=.js,.ts . && tslint --project .","lint-fix":"eslint -c ../eslintrc.yml --ext=.js,.ts --fix .","test":"jest --coverage","clean":"tsc -b --clean","watch":"tsc -b -w","integ":"cdk-integ","integ-assert":"cdk-integ-assert","jsii":"jsii","jsii-pacmak":"jsii-pacmak","build+lint+test":"npm run jsii && npm run lint && npm test && npm run integ-assert","snapshot-update":"npm run jsii && npm test -- -u && npm run integ-assert"},"jsii":{"outdir":"dist","targets":{"java":{"package":"software.amazon.konstruk.services.apigatewaysqs","maven":{"groupId":"software.amazon.konstruk","artifactId":"apigatewaysqs"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.ApiGatewaySqs","packageId":"Amazon.Konstruk.AWS.ApiGatewaySqs","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-apigateway-sqs","module":"aws_solutions_konstruk.aws_apigateway_sqs"}}},"dependencies":{"@aws-cdk/aws-apigateway":"~1.40.0","@aws-cdk/aws-sqs":"~1.40.0","@aws-cdk/aws-kms":"~1.40.0","@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-solutions-konstruk/core":"~0.8.1","constructs":"^3.0.2"},"devDependencies":{"@aws-cdk/assert":"~1.40.0","@types/jest":"^24.0.23","@types/node":"^10.3.0"},"jest":{"moduleFileExtensions":["js"]},"peerDependencies":{"@aws-cdk/aws-apigateway":"~1.40.0","@aws-cdk/aws-sqs":"~1.40.0","@aws-cdk/aws-kms":"~1.40.0","@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/core":"~1.40.0","@aws-solutions-konstruk/core":"~0.8.1","constructs":"^3.0.2"},"_resolved":"","_integrity":"","_from":"file:/codebuild/output/src866145426/src/deployment/publishing/npm/../../dist/js/aws-apigateway-sqs@0.8.1.jsii.tgz","bugs":{"url":"https://github.com/awslabs/aws-solutions-konstruk/issues"},"homepage":"https://github.com/awslabs/aws-solutions-konstruk#readme","_id":"@aws-solutions-konstruk/aws-apigateway-sqs@0.8.1","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-JgtrIF4TlqAfdVsqu2mhKcHiqcq08nyXG7OhbZWeAdLFzzD83Lt6M+28szF5X5Zde+QJ38b7tDwtrj1iO0Pnbw==","shasum":"43b03fead3d6e62e5a59d7d62b464ac11794287c","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-apigateway-sqs/-/aws-apigateway-sqs-0.8.1.tgz","fileCount":16,"unpackedSize":280166,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexvPKCRA9TVsSAnZWagAAHukP/RB/rrd/qmZ2AZClQ7l6\nTNd+/ieCUK5kUMryEpsy/7P+TfoSJbIuo3h++7BsII1tOMZEZ3VOA2OF6nZX\nlM0eho9yPL/g5pORGjdQSeZaiH43j6WHph9/t7CW1mT7wkfJg1woXVZ7rNdz\nzTgKSkAhMno0U5bBg8lNflG9/+sBXnpYd9kILxI+tbYb/LboIlC9anHN+FaK\n5m1jVmAp0G/ELbq/ZN03EYblZ46wrOV++LMlb/GfUqVOUqtlpAWfdpchoRyG\nXl3z3pjvDN8akecBxOfs4+1qkD9Q96r/7InhEKn6kHtMTmAKdr8BHbRo/t38\nrk7ZMxQ7tD5CkGD4gfcddmsYsiwxn2z2KZXjwJu9oazBabAiw/2UCRqPCbZj\n0tt6+6GfeOSe5BuuFiRe5lV9Hx3sBFfqReXCP96vccYfsvL6yUqtfiEZ+7b9\nZqCktzqQzGNYV0VmI7F/SSIoTixQMiKKDhL+FaPQRJmde1DVeCO8eXI+8wz6\nzHFm4XUkq7JnnjOZ/K+XUAiLB5UB0clIMDpY11kEJZm4OH2ntoSPeKtPwyoL\nsXqwplAoMeYTnsoP9jT8HcA1KrtjsvfJhZB2o05vLpejCWjwYADSw1M64Znq\nha3GrSSfMobmQIKVz0J3LawCP586YmSeAbI2qgwSxne2OhHInk5unp9sVwJL\nod0I\r\n=Rhox\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQD3q+H3aybIrCZrJNrhVhn+Stdkf9feKytigBZLNzSmrQIhANtWbDc/eev3INNeZn/HEaYEYGndFlnXTikjp1pohW5H"}]},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"_npmUser":{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aws-apigateway-sqs_0.8.1_1590096841636_0.0298618251379672"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-26T18:35:51.951Z","0.8.0":"2020-03-26T18:35:52.326Z","modified":"2022-04-04T17:05:43.513Z","0.8.1":"2020-05-21T21:34:01.775Z"},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"description":"CDK constructs for defining an interaction between an AWS Lambda function and an Amazon S3 bucket.","homepage":"https://github.com/awslabs/aws-solutions-konstruk#readme","repository":{"type":"git","url":"git+https://github.com/awslabs/aws-solutions-konstruk.git","directory":"source/patterns/@aws-solutions-konstruk/aws-apigateway-sqs"},"author":{"name":"Amazon Web Services","url":"https://aws.amazon.com"},"bugs":{"url":"https://github.com/awslabs/aws-solutions-konstruk/issues"},"license":"Apache-2.0","readme":"# aws-apigateway-sqs module\n\n\n---\n\n\n\n> **This is a _developer preview_ (public beta) module.**\n>\n> All classes are under active development and subject to non-backward compatible changes or removal in any\n> future version. These are not subject to the [Semantic Versioning](https://semver.org/) model.\n> 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.\n\n---\n\n\n| **API Reference**:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-apigateway-sqs/|\n|:-------------|:-------------|\n\n\n| **Language** | **Package** |\n|:-------------|-----------------|\n|{: style=\"height:16px;width:16px\"} Python|`aws_solutions_konstruk.aws_apigateway_sqs`|\n|{: style=\"height:16px;width:16px\"} Typescript|`@aws-solutions-konstruk/aws-apigateway-sqs`|\n\n## Overview\n\nThis AWS Solutions Konstruk implements an Amazon API Gateway connected to an Amazon SQS queue pattern.\n\nHere is a minimal deployable pattern definition:\n\n``` javascript\nconst { ApiGatewayToSqs } = require('@aws-solutions-konstruk/aws-apigateway-sqs');\n\nnew ApiGatewayToSqs(stack, 'ApiGatewayToSqsPattern', {\n apiGatewayProps: {},\n queueProps: {},\n encryptionKeyProps: {},\n deployDeadLetterQueue?: true,\n maxReceiveCount?: 3\n});\n\n```\n\n## Initializer\n\n``` text\nnew ApiGatewayToSqs(scope: Construct, id: string, props: ApiGatewayToSqsProps);\n```\n\n_Parameters_\n\n* scope [`Construct`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.Construct.html)\n* id `string`\n* props [`ApiGatewayToSqsProps`](#pattern-construct-props)\n\n## Pattern Construct Props\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|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.|\n|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.|\n|deployDeadLetterQueue|`boolean`|Whether to deploy a secondary queue to be used as a dead letter queue.|\n|maxReceiveCount|`number`|The number of times a message can be unsuccesfully dequeued before being moved to the dead-letter queue.|\n\n## Pattern Properties\n\n| **Name** | **Type** | **Description** |\n|:-------------|:----------------|-----------------|\n|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.|\n|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.|\n\n## Sample API Usage\n\n| **Method** | **Request Path** | **Request Body** | **Queue Action** | **Description** |\n|:-------------|:----------------|-----------------|-----------------|-----------------|\n|GET|`/`| |`sqs::ReceiveMessage`|Retrieves a message from the queue.|\n|POST|`/`| `{ \"data\": \"Hello World!\" }` |`sqs::SendMessage`|Delivers a message to the queue.|\n|DELETE|`/message?receiptHandle=[value]`||`sqs::DeleteMessage`|Deletes a specified message from the queue|\n\n## Architecture\n\n\n***\n© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.","readmeFilename":"README.md"}