Categorygithub.com/christian-korneck/awssc-go-dist/awssolutionsconstructsawscloudfrontapigatewaylambda/v2
modulepackage
2.2.0
Repository: https://github.com/christian-korneck/awssc-go-dist.git
Documentation: pkg.go.dev

# README

aws-cloudfront-apigateway-lambda module


Stability: Stable


Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_cloudfront_apigateway_lambda
Typescript Logo Typescript@aws-solutions-constructs/aws-cloudfront-apigateway-lambda
Java Logo Javasoftware.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:

import { CloudFrontToApiGatewayToLambda } from '@aws-solutions-constructs/aws-cloudfront-apigateway-lambda';

new CloudFrontToApiGatewayToLambda(this, 'test-cloudfront-apigateway-lambda', {
    lambdaFunctionProps: {
        code: lambda.Code.fromAsset(`${__dirname}/lambda`),
        runtime: lambda.Runtime.NODEJS_14_X,
        handler: 'index.handler'
    }
});

Initializer

new CloudFrontToApiGatewayToLambda(scope: Construct, id: string, props: CloudFrontToApiGatewayToLambdaProps);

Parameters

Pattern Construct Props

NameTypeDescription
existingLambdaObj?lambda.FunctionExisting instance of Lambda Function object, providing both this and lambdaFunctionProps will cause an error.
lambdaFunctionProps?lambda.FunctionPropsOptional user provided props to override the default props for the Lambda function.
apiGatewayProps?api.LambdaRestApiPropsOptional user provided props to override the default props for API Gateway
cloudFrontDistributionProps?cloudfront.DistributionPropsOptional user provided props to override the default props for CloudFront Distribution
insertHttpSecurityHeaders?booleanOptional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from CloudFront
logGroupProps?logs.LogGroupPropsOptional user provided props to override the default props for for the CloudWatchLogs LogGroup.
cloudFrontLoggingBucketProps?s3.BucketPropsOptional user provided props to override the default props for the CloudFront Logging Bucket.

Pattern Properties

NameTypeDescription
cloudFrontWebDistributioncloudfront.CloudFrontWebDistributionReturns an instance of cloudfront.CloudFrontWebDistribution created by the construct
cloudFrontFunction?cloudfront.FunctionReturns an instance of the Cloudfront function created by the pattern.
cloudFrontLoggingBuckets3.BucketReturns an instance of the logging bucket for CloudFront WebDistribution.
apiGatewayapi.RestApiReturns an instance of the API Gateway REST API created by the pattern.
apiGatewayCloudWatchRole?iam.RoleReturns an instance of the iam.Role created by the construct for API Gateway for CloudWatch access.
apiGatewayLogGrouplogs.LogGroupReturns an instance of the LogGroup created by the construct for API Gateway access logging to CloudWatch.
lambdaFunctionlambda.FunctionReturns 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

Architecture Diagram


© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.

# Packages

Package jsii contains the functionaility needed for jsii packages to initialize their dependencies and themselves.

# Functions

Checks if `x` is a construct.
No description provided by the author
No description provided by the author

# Structs

No description provided by the author

# Interfaces

No description provided by the author