CDK constructs for defining an interaction between an API Gateway and a Lambda function.
Project description
aws-apigateway-lambda module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_apigateway_lambda |
Typescript | @aws-solutions-constructs/aws-apigateway-lambda |
Java | software.amazon.awsconstructs.services.apigatewaylambda |
Overview
This AWS Solutions Construct implements an Amazon API Gateway REST API connected to an AWS Lambda function pattern.
Here is a minimal deployable pattern definition in Typescript:
import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', {
lambdaFunctionProps: {
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler',
code: lambda.Code.fromAsset(`${__dirname}/lambda`)
}
});
Initializer
new ApiGatewayToLambda(scope: Construct, id: string, props: ApiGatewayToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
ApiGatewayToLambdaProps
Pattern Construct Props
Name | Type | Description |
---|---|---|
existingLambdaObj? | lambda.Function |
Existing instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error. |
lambdaFunctionProps? | lambda.FunctionProps |
User provided props to override the default props for the Lambda function. |
apiGatewayProps? | api.LambdaRestApiProps |
Optional user-provided props to override the default props for the API. |
logGroupProps? | logs.LogGroupProps |
User provided props to override the default props for for the CloudWatchLogs LogGroup. |
Pattern Properties
Name | Type | Description |
---|---|---|
lambdaFunction | lambda.Function |
Returns an instance of the Lambda function created by the pattern. |
apiGateway | api.LambdaRestApi |
Returns an instance of the API Gateway REST API created by the pattern. |
apiGatewayCloudWatchRole? | iam.Role |
Returns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access. |
apiGatewayLogGroup | logs.LogGroup |
Returns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch. |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
Amazon API Gateway
- Deploy an edge-optimized API endpoint
- Enable CloudWatch logging for API Gateway
- Configure least privilege access IAM role for API Gateway
- Set the default authorizationType for all API methods to IAM
- Enable X-Ray Tracing
AWS Lambda Function
-
Configure limited privilege access IAM role for Lambda function
-
Enable reusing connections with Keep-Alive for NodeJs Lambda function
-
Enable X-Ray Tracing
-
Set Environment Variables
- AWS_NODEJS_CONNECTION_REUSE_ENABLED (for Node 10.x and higher functions)
Architecture
© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for aws-solutions-constructs.aws-apigateway-lambda-2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0ce4cacd350eceb9452501efcfd840cd436ac16470d2b86ac88077c3721a8330 |
|
MD5 | 9d4315e9e6e3040332e4141bd710f973 |
|
BLAKE2b-256 | 144542d9192eb15a9d29f2232f5023966893729924ca860789eddabc8ee26bb4 |
Close
Hashes for aws_solutions_constructs.aws_apigateway_lambda-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2e755e1fd2b1ea347e6107080a13b757d231aa66a0bcecadb1f7b57e04f3254a |
|
MD5 | bab94b260f55f985e3be86e3d641eb88 |
|
BLAKE2b-256 | f5459e1bdb367afa6756557987961cbe329679231bed8d8947fb4ee6f245fab8 |