{"_id":"@aws-solutions-konstruk/aws-apigateway-dynamodb","_rev":"2-705c233567aad1bc69c6df2f7c13b772","name":"@aws-solutions-konstruk/aws-apigateway-dynamodb","dist-tags":{"latest":"0.8.1"},"versions":{"0.8.0":{"name":"@aws-solutions-konstruk/aws-apigateway-dynamodb","version":"0.8.0","description":"CDK Constructs for AWS API Gateway and Amazon DynamoDB integration.","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-dynamodb"},"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-no-clean":"cdk-integ --no-clean","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.apigatewaydynamodb","maven":{"groupId":"software.amazon.konstruk","artifactId":"apigatewaydynamodb"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.ApiGatewayDynamoDB","packageId":"Amazon.Konstruk.AWS.ApiGatewayDynamoDB","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-apigateway-dynamodb","module":"aws_solutions_konstruk.aws_apigateway_dynamodb"}}},"dependencies":{"@aws-cdk/core":"~1.25.0","@aws-cdk/aws-apigateway":"~1.25.0","@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/aws-dynamodb":"~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/core":"~1.25.0","@aws-cdk/aws-apigateway":"~1.25.0","@aws-cdk/aws-iam":"~1.25.0","@aws-cdk/aws-dynamodb":"~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-dynamodb@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-dynamodb@0.8.0","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-apPG3qrrm7FHQ03szmB8US0l1N66wrfaGyvD0qb6+w932NUHzQHJvnP4wCFmHC4RzmiYgrNk4NH6vQWPenMqSQ==","shasum":"74dea8d7225c082b3e3efcaa55d955d3f8bd8073","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-apigateway-dynamodb/-/aws-apigateway-dynamodb-0.8.0.tgz","fileCount":16,"unpackedSize":228428,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefPW8CRA9TVsSAnZWagAAdvoP/A80wZVoepafiufg9Xqy\nXHaAh9JwxHRXFaB8DUuTK5vp4K8t8vDAUFaQXJiH1+/hryevvsR3ugKO0kqH\nQx8N0JIlwuB9BCtvBBgsjl+7/GCEd4ZQun+iUgp/A91a8gqM4QEumh0IuqhR\ncq/f3eUfnfVOoW51oMlSAg8HzRuomnKrCLyvl2EIFAi1J4QvUE2vQTshr4/6\noLobn1huIirxyXyL0VoR5XIRiHsPmJ0g/qj4ayUH2eWOvGOo1VTjdyle7uKl\nw2N/eFnhkEHM//rZJHNg7vPaRoIrJS2zgXK3CxsfOQMFPRXbNURDsa/57mfq\nN6shxB8MoMU5c9FeT8MvIMvR85/XONlWB7QQNkwo5KhNM8mtA0M8dDXoovuY\nfg687pkbeImxGo7nnM8mEviQXBuZUp/jIZSEpZHAIMiTvIIqYoXZiVdm8m3Z\nuBeEqrFtzjZSUjMXLExd7pbXTIlDUd0R1syKu0K6DDm1bGAdAUMhFMHMeTCw\niBb747YBqn2/10YdWA7QOoFvHbrzvmTOW1xnIEo2NvQF7wC/CxzJAQjTnWXq\nnhBjIwuTonBcVjnHR495RT8SzMGl5rkMg7WDE8un1QgGt8ucG18SR+yAEYQM\nacdZQ6dsUmQV+UvcgLELfoMUOteMvy0lf26z4WXfbBbyaAuqMM4/hOS9o1bX\nkPOu\r\n=WEnQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBQRMCcFN/5C6tHAWYZ1LqcbGlr+/w0jufP6eVfw+dpdAiEAzMmzQx604/wbBJoHAE9NPU0uUqyt55zioxDqji+mQZ8="}]},"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-dynamodb_0.8.0_1585247676258_0.7325669499292764"},"_hasShrinkwrap":false},"0.8.1":{"name":"@aws-solutions-konstruk/aws-apigateway-dynamodb","version":"0.8.1","description":"CDK Constructs for AWS API Gateway and Amazon DynamoDB integration.","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-dynamodb"},"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-no-clean":"cdk-integ --no-clean","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.apigatewaydynamodb","maven":{"groupId":"software.amazon.konstruk","artifactId":"apigatewaydynamodb"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.ApiGatewayDynamoDB","packageId":"Amazon.Konstruk.AWS.ApiGatewayDynamoDB","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-apigateway-dynamodb","module":"aws_solutions_konstruk.aws_apigateway_dynamodb"}}},"dependencies":{"@aws-cdk/core":"~1.40.0","@aws-cdk/aws-apigateway":"~1.40.0","@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/aws-dynamodb":"~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/core":"~1.40.0","@aws-cdk/aws-apigateway":"~1.40.0","@aws-cdk/aws-iam":"~1.40.0","@aws-cdk/aws-dynamodb":"~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-dynamodb@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-dynamodb@0.8.1","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-7wGAfE3dVDrKLCqxnhod+GfroN2T9y7ZxpZKzft4GT1wP8qm+KY8iwpLfw6QOrmoqaxtgfbYP2BeBZepyN7kLA==","shasum":"3cab3e494912590fa99534c1e5b930ac1ecbfb02","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-apigateway-dynamodb/-/aws-apigateway-dynamodb-0.8.1.tgz","fileCount":16,"unpackedSize":221419,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexvPlCRA9TVsSAnZWagAAF+IP/1qXZDd2vdfDKQfyUdOH\nXZOMB6x9JoqbHlzb6dN1SYE/RsiMOQCG5uRk74mt/mIOaQ5j7l4vBWTAbtdu\nOSKlyvN27bW4zYhKG9oMwNMmV8dWc9dwxzSkCyC2Ab6DrVube6PKJk/E5CDT\nO4Op07CLs6GlqqIQMwIFPFKZd8YXAaqvu/W5zmHfiq/QBL2B2q9TXX8ZwhaY\nvDIgi44Q9KSIdSuIV/NIdpRNKJShQC8UOYIHY/WmQqUxHeL+lxws/NoGuzaa\n97QMHMYlqHFeRjBfXLAz/2VxjQK9WhUGZGrAJek3xte2VBNGTwatsvp5BArA\nKc7a4L8dYY03C6OywW/wPDv2wlzUoGQHFm4O4IriaeCYd1w/HmsQ1tBn+CoR\nHqOv9hWjJ2/drZGwqKfjNVJXXzR724fug2h04PrWvGKXnUurfiusAEhh3PWF\nzB/eZM5DZuvaxqQvY42mn2Ty+Z2K6UZQekraSDiFWJHQCbqXx2oGc7OckFS6\nANIbXpmaX9T1p9943/UPz9ukdKlT0qNK4AeRKhLCdG3MHvKRBkuUTJphj0Sf\nFWph3RObu9nRHsMGLEkHhR3mqaxqE8w/VIoZ3Kwu3F4mcqA+yL4Lma6Cptn9\nSc2g3QZTElmmvAN9nQzSPWc+lmKR6Ln458mhqcwSCFPqmCawVDytxjnPmC7k\nEoES\r\n=j0Sf\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIA5HDJL4Qwpp7lhW8bfbywUCTN6jD7/2fz8+ftqJg+W9AiAxY4/1EySzGJFwcX6CITFCORe3BRMs11rvEAFO3fQ1Kw=="}]},"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-dynamodb_0.8.1_1590096869102_0.2546088366265553"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-26T18:34:36.019Z","0.8.0":"2020-03-26T18:34:36.404Z","modified":"2022-04-04T17:05:43.158Z","0.8.1":"2020-05-21T21:34:29.386Z"},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"description":"CDK Constructs for AWS API Gateway and Amazon DynamoDB integration.","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-dynamodb"},"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-dynamodb module\n<!--BEGIN STABILITY BANNER-->\n\n---\n\n![Stability: Experimental](https://img.shields.io/badge/stability-Experimental-important.svg?style=for-the-badge)\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<!--END STABILITY BANNER-->\n\n| **API Reference**:| <span style=\"font-weight: normal\">http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-apigateway-dynamodb/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\n\n\n| **Language**     | **Package**        |\n|:-------------|-----------------|\n|![Python Logo](https://docs.aws.amazon.com/cdk/api/latest/img/python32.png){: style=\"height:16px;width:16px\"} Python|`aws_solutions_konstruk.aws_apigateway_dynamodb`|\n|![Typescript Logo](https://docs.aws.amazon.com/cdk/api/latest/img/typescript32.png){: style=\"height:16px;width:16px\"} Typescript|`@aws-solutions-konstruk/aws-apigateway-dynamodb`|\n\n## Overview\nThis AWS Solutions Konstruk implements an Amazon API Gateway REST API connected to Amazon DynamoDB table.\n\nHere is a minimal deployable pattern definition:\n\n``` javascript\nimport { ApiGatewayToDynamoDBProps, ApiGatewayToDynamoDB } from \"@aws-solutions-konstruk/aws-apigateway-dynamodb\";\n\nconst props: ApiGatewayToDynamoDBProps = {};\n\nnew ApiGatewayToDynamoDB(stack, 'test-api-gateway-dynamodb-default', props);\n\n```\n\n## Initializer\n\n``` text\nnew ApiGatewayToDynamoDB(scope: Construct, id: string, props: ApiGatewayToDynamoDBProps);\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 [`ApiGatewayToDynamoDBProps`](#pattern-construct-props)\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|dynamoTableProps|[`dynamodb.TableProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-dynamodb.TableProps.html)|Optional user provided props to override the default props for DynamoDB Table|\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|allowCreateOperation|`boolean`|Whether to deploy API Gateway Method for Create operation on Dynamodb DB table.|\n|createRequestTemplate|`string`|API Gateway Request template for Create method, required if allowCreateOperation set to true|\n|allowReadOperation|`boolean`|Whether to deploy API Gateway Method for Read operation on Dynamodb DB table.|\n|allowUpdateOperation|`boolean`|Whether to deploy API Gateway Method for Update operation on Dynamodb DB table.|\n|updateRequestTemplate|`string`|API Gateway Request template for Update method, required if allowUpdateOperation set to true|\n|allowDeleteOperation|`boolean`|Whether to deploy API Gateway Method for Delete operation on Dynamodb DB table.|\n\n## Pattern Properties\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|restApi()|[`api.RestApi`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.RestApi.html)|Returns an instance of the api.RestApi created by the construct.|\n|dynamoTable()|[`dynamodb.Table`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-dynamodb.Table.html)|Returns an instance of dynamodb.Table created by the construct.|\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.\n","readmeFilename":"README.md"}