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:
# Example automatically generated without compilation. See https://github.com/aws/jsii/issues/826
from aws_solutions_constructs.aws_apigateway_lambda import ApiGatewayToLambda
ApiGatewayToLambda(self, "ApiGatewayToLambdaPattern",
lambda_function_props=FunctionProps(
runtime=lambda_.Runtime.NODEJS_10_X,
handler="index.handler",
code=lambda_.Code.from_asset(f"{__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-1.116.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | abef3e92f8c49d1e2c4d911a7ae2e6d4accd759522d434360c48c00500bd96aa |
|
MD5 | 08f63cf77aeddf2f32e623e087c3a11b |
|
BLAKE2b-256 | e747d693da38f4486f27ed718908e5927a10a683acad0b1bbb10c48acae0e24d |
Close
Hashes for aws_solutions_constructs.aws_apigateway_lambda-1.116.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 13974748bcd87513ffba0f8b33f2dfac1d765b35485489254edfd92f82a0b9e7 |
|
MD5 | 964d48e7478b02b00529421ad0fc36ce |
|
BLAKE2b-256 | 9c0b37007dd0dad96f1ff2314e56f62f688f5fb55781e2b98f4e5f13a7f8b2f0 |