{"_id":"@aws-solutions-konstruk/aws-apigateway-lambda","_rev":"2-b7fc3ed452b6be79cc971b104be8096a","name":"@aws-solutions-konstruk/aws-apigateway-lambda","dist-tags":{"latest":"0.8.1"},"versions":{"0.8.0":{"name":"@aws-solutions-konstruk/aws-apigateway-lambda","version":"0.8.0","description":"CDK constructs for defining an interaction between an API Gateway and a Lambda function.","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-lambda"},"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.apigatewaylambda","maven":{"groupId":"software.amazon.konstruk","artifactId":"apigatewaylambda"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.ApiGatewayLambda","packageId":"Amazon.Konstruk.AWS.ApiGatewayLambda","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-apigateway-lambda","module":"aws_solutions_konstruk.aws_apigateway_lambda"}}},"dependencies":{"@aws-cdk/aws-apigateway":"~1.25.0","@aws-cdk/aws-lambda":"~1.25.0","@aws-cdk/aws-logs":"~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-lambda":"~1.25.0","@aws-cdk/aws-logs":"~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-lambda@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-lambda@0.8.0","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-JaJ888Tf2cIo55hhzVH0wusPNtrdf0DpW+wkeO7FTo2kL/9fhuiIpVjSS7QbsuYERz4y5QeejhwiGFiY2lgLag==","shasum":"8b0af6270048cf2431743e19aed7b236700ddb6c","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-apigateway-lambda/-/aws-apigateway-lambda-0.8.0.tgz","fileCount":17,"unpackedSize":261518,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJefPWICRA9TVsSAnZWagAANPYP/jbpagHhzC6GFtRyt97U\n23SdQ9rxVpSiECoPEOzcViYG7zbqmUtamu4Zr86JWB4D5fn5qG65SvtoTJGD\nA5FDUntQB7WZyIzjUA4wdg+B0WiKnuwdc5AID+EGDIAI9y+oTVSQNsEZwP28\nnGcBY8jrqNbp/nkynljUG3tz7tjVOWbUOGBGPzn0yx2RKLqRbQw5nrg8y+xv\nddXFLX20CHj5ganl0fdptKuZK6PTCHaAE26p8h2zzb1EvAOJrMESRU8Vx4QE\nJYBVX/uw2pvON6knUy81z3wl89V/NshYxXTj+VreRnQHbVDrJr3MyjhgjWKz\nS7KQ6gTCmNOBCh8vVzEdol/IHWdkN03xNu9es+hpBCZxH1fyP/J3I0fkermn\nQ5sByoaFbIwabmc4qSYFWfAVJtQFzvKoVSJcjfSolLMPPcXb4s88va2yd5vJ\nOkVJF+d3EzzsclL3dUICqF3Yg9s00mtpBvh+iLtIzuO1NKl37XYcaedR++Ll\ni0wtSoRKo1cX6ehWgMewonzAQS+4sD17BmqGqtC/Ftc29r+Fj85ux5G+EYYT\nVRoLXbZak++4bjG8vVOEy++V6CNLEPmpN0XQoegglzCo9eUgYJXrEaIY1pZ1\nVZ8Hyn3QXGUPL4KzKtUm6EiniKgFDCSeAX5zRZddO1sku9Ii5jPVmY2pKMZt\nGjt7\r\n=N3vr\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIE+X6XRsfyQrRWC0WFAj5Pn1g5ZrOg76GnpYz6a166IAAiBjizVbqCvacx9zTzHzLEAFQ1FBQ/b9zoycj3nb3eteSQ=="}]},"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-lambda_0.8.0_1585247624175_0.5661762196028248"},"_hasShrinkwrap":false},"0.8.1":{"name":"@aws-solutions-konstruk/aws-apigateway-lambda","version":"0.8.1","description":"CDK constructs for defining an interaction between an API Gateway and a Lambda function.","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-lambda"},"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.apigatewaylambda","maven":{"groupId":"software.amazon.konstruk","artifactId":"apigatewaylambda"}},"dotnet":{"namespace":"Amazon.Konstruk.AWS.ApiGatewayLambda","packageId":"Amazon.Konstruk.AWS.ApiGatewayLambda","signAssembly":true,"iconUrl":"https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png"},"python":{"distName":"aws-solutions-konstruk.aws-apigateway-lambda","module":"aws_solutions_konstruk.aws_apigateway_lambda"}}},"dependencies":{"@aws-cdk/aws-apigateway":"~1.40.0","@aws-cdk/aws-lambda":"~1.40.0","@aws-cdk/aws-logs":"~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-lambda":"~1.40.0","@aws-cdk/aws-logs":"~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-lambda@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-lambda@0.8.1","_nodeVersion":"10.19.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-CHzMmBYS0o9ndEthy+S7tD5IOmK36s15z68IfO9FdJ6rjLDJJZ9Dft0wkUnkBaJw5ngD3Ec9VCDm2Cph/LADNA==","shasum":"107af75d78c2b7d65e28f8919f4a619ac5f64e38","tarball":"https://registry.npmjs.org/@aws-solutions-konstruk/aws-apigateway-lambda/-/aws-apigateway-lambda-0.8.1.tgz","fileCount":17,"unpackedSize":293699,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJexvPVCRA9TVsSAnZWagAAeUsQAIyVEMrIFly8bIpIT1da\n+Mfx6BYc4HpDfq8QJESjwn8u2AaVpJYcyC+wd3xZzODVWEz37/3I/E/aDjP7\n/BoATNT0c5wWGYz4G1RXA45yrkNdEdhqWbIrH1jeA0VObiAXmqw8GGz3nW5F\n7TCEzGuM+bHqZtheCbcf3PwfaRpRoaOx7y4kWdacMNFWnPrEgx7k1shG6tpD\nYdOAX5JwmDG1rOY0zLqfW6G7jzHPsVCNsZXCNCTaEo9spdWdlnKzc3Hy9jX8\n1ttRBeAZkcsfAor5MoymjLqjV9hlK41L8QlKd7fu5OErPIaJOnXV6Nqg6RHB\nQUQASa4ecUa2E+dGTUz0Jaok5mIPoyGf4dompGJAYbbqLuhy1M7CdjsSq0kB\n6w4TMGksEEe+/N9U+Leeerl/ktQPtDmRKDFOS/xzmfP7AZqaGnHTckMW1zeX\n+1OsZHk8n7F4aV3/m+azkDPYBtx388cWvhFYYypaHB81z6AZJyRZT84VCqsN\nA9KQBYQZAZm8Bdf7dSKDhsCIEtHndYFUx7pmTmNkJAmd3fcGE94Z05/Oh4Uf\n6sivrdkR8mgHjRoI94Fel+v8ByYsGNG7+9hmIXWIoNCJPgq6BUXzOZIe7B/7\nQ/oh+Z8Ant5pbDfJkAhpJkNMlgU4cXiGkStMijVBvhY5zjhQC0BJcOydFRIB\nshop\r\n=MuYL\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDseIMewP2sTcf8HfNjBINTDtujY72bH+wpR/b4zofYRgIhAIon47N7FHfrhiWa9R1TsgnOht/EKTroAVnr2hK7AJ9l"}]},"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-lambda_0.8.1_1590096853293_0.40183923101963726"},"_hasShrinkwrap":false}},"time":{"created":"2020-03-26T18:33:43.926Z","0.8.0":"2020-03-26T18:33:44.272Z","modified":"2022-04-04T17:05:43.363Z","0.8.1":"2020-05-21T21:34:13.440Z"},"maintainers":[{"name":"aws-solutions-konstruk-support","email":"aws-solutions-konstruk-support@amazon.com"}],"description":"CDK constructs for defining an interaction between an API Gateway and a Lambda function.","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-lambda"},"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-lambda 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-lambda/</span>|\n|:-------------|:-------------|\n<div style=\"height:8px\"></div>\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_lambda`|\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-lambda`|\n\n## Overview\n\nThis AWS Solutions Konstruk implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.\n\nHere is a minimal deployable pattern definition:\n\n``` javascript\nconst { ApiGatewayToLambda } = require('@aws-solutions-konstruk/aws-apigateway-lambda');\n\nnew ApiGatewayToLambda(stack, 'ApiGatewayToLambdaPattern', {\n    deployLambda: true,\n    lambdaFunctionProps: {\n        runtime: lambda.Runtime.NODEJS_10_X,\n        handler: 'index.handler',\n        code: lambda.Code.asset(`${__dirname}/lambda`)\n    }\n});\n\n```\n\n## Initializer\n\n``` text\nnew ApiGatewayToLambda(scope: Construct, id: string, props: ApiGatewayToLambdaProps);\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 [`ApiGatewayToLambdaProps`](#pattern-construct-props)\n\n## Pattern Construct Props\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|deployLambda|`boolean`|Whether to create a new Lambda function or use an existing Lambda function. If set to false, you must provide an existing function for the `existingLambdaObj` property.|\n|existingLambdaObj?|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|An optional, existing Lambda function. This property is required if `deployLambda` is set to false.|\n|lambdaFunctionProps?|[`lambda.FunctionProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.FunctionProps.html)|Optional user-provided props to override the default props for the Lambda function. This property is only required if `deployLambda` is set to true.|\n|apiGatewayProps?|[`api.LambdaRestApiProps`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.LambdaRestApi.html)|Optional user-provided props to override the default props for the API.|\n\n## Pattern Properties\n\n| **Name**     | **Type**        | **Description** |\n|:-------------|:----------------|-----------------|\n|lambdaFunction()|[`lambda.Function`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-lambda.Function.html)|Returns an instance of the Lambda function created by the pattern.|\n|restApi()|[`api.LambdaRestApi`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-apigateway.LambdaRestApi.html)|Returns an instance of the API Gateway REST API created by the pattern.|\n\n## Architecture\n![Architecture Diagram](architecture.png)\n\n***\n&copy; Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.","readmeFilename":"README.md"}