CDK Constructs for AWS Cloudfront to AWS API Gateway to AWS Lambda integration.
Project description
aws-cloudfront-apigateway-lambda module
---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 |
Overview
This AWS Solutions Construct implements an AWS CloudFront fronting an Amazon API Gateway Lambda backed REST API.
Here is a minimal deployable pattern definition:
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { CloudFrontToApiGatewayToLambda } from '@aws-solutions-constructs/aws-cloudfront-apigateway-lambda';
import * as lambda from 'aws-cdk-lib/aws-lambda';
new CloudFrontToApiGatewayToLambda(this, 'test-cloudfront-apigateway-lambda', {
lambdaFunctionProps: {
code: lambda.Code.fromAsset(`lambda`),
runtime: lambda.Runtime.NODEJS_16_X,
handler: 'index.handler'
}
});
Python
from aws_solutions_constructs.aws_cloudfront_apigateway_lambda import CloudFrontToApiGatewayToLambda
from aws_cdk import (
aws_lambda as _lambda,
Stack
)
from constructs import Construct
CloudFrontToApiGatewayToLambda(self, 'test-cloudfront-apigateway-lambda',
lambda_function_props=_lambda.FunctionProps(
code=_lambda.Code.from_asset('lambda'),
runtime=_lambda.Runtime.PYTHON_3_9,
handler='index.handler'
)
)
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.cloudfrontapigatewaylambda.*;
new CloudFrontToApiGatewayToLambda(this, "test-cloudfront-apigateway-lambda",
new CloudFrontToApiGatewayToLambdaProps.Builder()
.lambdaFunctionProps(new FunctionProps.Builder()
.runtime(Runtime.NODEJS_16_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 |
Optional 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 |
responseHeadersPolicyProps? | cloudfront.ResponseHeadersPolicyProps |
Optional user provided configuration that cloudfront applies to all http responses. |
logGroupProps? | logs.LogGroupProps |
Optional user provided props to override the default props for for the CloudWatchLogs LogGroup. |
cloudFrontLoggingBucketProps? | s3.BucketProps |
Optional user provided props to override the default props for the CloudFront Logging Bucket. |
Pattern Properties
Name | Type | Description |
---|---|---|
cloudFrontWebDistribution | cloudfront.Distribution |
Returns an instance of cloudfront.Distribution created by the construct |
cloudFrontFunction? | cloudfront.Function |
Returns an instance of the Cloudfront function created by the pattern. |
cloudFrontLoggingBucket | s3.Bucket |
Returns an instance of the logging bucket for CloudFront Distribution. |
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 Distribution
- Enable automatic injection of best practice HTTP security headers in all responses from CloudFront Distribution
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 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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
Close
Hashes for aws_solutions_constructs.aws_cloudfront_apigateway_lambda-2.43.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c71b40cd1ee90c2739512fc4a633821e33fac203b8ca8846a5eb4c5554b5e8bb |
|
MD5 | cb2752094bb6e2f0798faf360151f62f |
|
BLAKE2b-256 | 3f7be9b2ba570bfb7962a7f16abda2a6f606c4f0a47335a26dacdd17edcd11c8 |