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 |
---|---|
aws_solutions_constructs.aws_apigateway_lambda |
|
@aws-solutions-constructs/aws-apigateway-lambda |
|
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:
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { ApiGatewayToLambda } from '@aws-solutions-constructs/aws-apigateway-lambda';
import * as lambda from 'aws-cdk-lib/aws-lambda';
new ApiGatewayToLambda(this, 'ApiGatewayToLambdaPattern', {
lambdaFunctionProps: {
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler',
code: lambda.Code.fromAsset(`lambda`)
}
});
Python
from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
from aws_cdk import (
aws_lambda as _lambda,
Stack
)
from constructs import Construct
ApiGatewayToLambda(self, 'ApiGatewayToLambdaPattern',
lambda_function_props=_lambda.FunctionProps(
runtime=_lambda.Runtime.PYTHON_3_9,
handler='index.handler',
code=_lambda.Code.from_asset('lambda')
)
)
Java
import software.constructs.Construct;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awsconstructs.services.apigatewaylambda.*;
new ApiGatewayToLambda(this, "ApiGatewayToLambdaPattern", new ApiGatewayToLambdaProps.Builder()
.lambdaFunctionProps(new FunctionProps.Builder()
.runtime(Runtime.NODEJS_14_X)
.code(Code.fromAsset("lambda"))
.handler("index.handler")
.build())
.build());
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-1.152.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c2c589e08eda7f3d70cec137bb83cc3af569fe3004a59288f9de1a077954123 |
|
MD5 | 8d81e43aa57455f32a5845d2af54a073 |
|
BLAKE2b-256 | 0d47becfbddae3b3b443b8cf7cc7d0553c7cd1a8b26f0377746ae5b0d645a6b9 |
Close
Hashes for aws_solutions_constructs.aws_apigateway_lambda-1.152.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d3086030e327d4639c8a07485a3dba4d461d2b22c51225436ae042d54e429f8 |
|
MD5 | 69dddc189eac55ef38f5983459d1a67c |
|
BLAKE2b-256 | 77333431968b95702ec6888f33a9a7dd400336170b0568f04b57d475318b890b |