CDK Constructs for AWS Cloudfront to AWS API Gateway to AWS Lambda integration.
Project description
aws-cloudfront-apigateway-lambda module
---All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. 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.
Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_cloudfront_apigateway_lambda |
Typescript | @aws-solutions-constructs/aws-cloudfront-apigateway-lambda |
Java | software.amazon.awsconstructs.services.cloudfrontapigatewaylambda |
This AWS Solutions Construct implements an AWS CloudFront fronting an Amazon API Gateway Lambda backed REST API.
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_cloudfront_apigateway_lambda import CloudFrontToApiGatewayToLambda
CloudFrontToApiGatewayToLambda(self, "test-cloudfront-apigateway-lambda",
lambda_function_props=FunctionProps(
code=lambda_.Code.from_asset(f"{__dirname}/lambda"),
runtime=lambda_.Runtime.NODEJS_12_X,
handler="index.handler"
)
)
Initializer
new CloudFrontToApiGatewayToLambda(scope: Construct, id: string, props: CloudFrontToApiGatewayToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
CloudFrontToApiGatewayToLambdaProps
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 API Gateway |
cloudFrontDistributionProps? | cloudfront.DistributionProps |
Optional user provided props to override the default props for CloudFront Distribution |
insertHttpSecurityHeaders? | boolean |
Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from CloudFront |
logGroupProps? | logs.LogGroupProps |
User provided props to override the default props for for the CloudWatchLogs LogGroup. |
Pattern Properties
Name | Type | Description |
---|---|---|
cloudFrontWebDistribution | cloudfront.CloudFrontWebDistribution |
Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct |
edgeLambdaFunctionVersion | lambda.Version |
Returns an instance of the edge Lambda function version created by the pattern. |
cloudFrontLoggingBucket | s3.Bucket |
Returns an instance of the logging bucket for CloudFront WebDistribution. |
apiGateway | api.RestApi |
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. |
lambdaFunction | lambda.Function |
Returns an instance of the Lambda function created by the pattern. |
Default settings
Out of the box implementation of the Construct without any override will set the following defaults:
Amazon CloudFront
- Configure Access logging for CloudFront WebDistribution
- Enable automatic injection of best practice HTTP security headers in all responses from CloudFront WebDistribution
Amazon API Gateway
- Deploy a regional 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 NONE
- 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
Hashes for aws-solutions-constructs.aws-cloudfront-apigateway-lambda-1.113.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 266990b993c55d6909b474a67981fb982d5de21ebbbb4f882327f4fe8da56f89 |
|
MD5 | 2a4c0b247c526f7880ac75a848e16f31 |
|
BLAKE2b-256 | 5d618f1adaff8e70c45a7012d085370dd22e8fa05408df1d756202c39bdc0102 |
Hashes for aws_solutions_constructs.aws_cloudfront_apigateway_lambda-1.113.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e5ad041b1b92b0e4217897c105573ca7a3ea47db559a557a4d125cd1ae4293c |
|
MD5 | d5ab34b62f060212d0c859a203b07ec4 |
|
BLAKE2b-256 | 1670679ead093c027fe14dbadd3501a76423714fd03987cd194d67052beb5cbe |