@aws-solutions-konstruk/aws-cloudfront-apigateway-lambda
v0.8.1
Published
CDK Constructs for AWS Cloudfront to AWS API Gateway to AWS Lambda integration.
Downloads
10
Readme
aws-cloudfront-apigateway-lambda module
This is a developer preview (public beta) 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.
| API Reference:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-cloudfront-apigateway-lambda/| |:-------------|:-------------|
| Language | Package |
|:-------------|-----------------|
|{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_cloudfront_apigateway_lambda
|
|{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-cloudfront-apigateway-lambda
|
This AWS Solutions Konstruk implements an AWS Cloudfront fronting an Amazon API Gateway Lambda backed REST API.
Here is a minimal deployable pattern definition:
import * as defaults from '@aws-solutions-konstruk/core';
import { CloudFrontToApiGatewayToLambda } from '@aws-solutions-konstruk/aws-cloudfront-apigateway-lambda';
const stack = new Stack();
const lambdaProps: lambda.FunctionProps = {
code: lambda.Code.asset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler'
};
new CloudFrontToApiGatewayToLambda(stack, 'test-cloudfront-apigateway-lambda', {
lambdaFunctionProps: lambdaProps,
deployLambda: true
});
Initializer
new CloudFrontToApiGatewayToLambda(scope: Construct, id: string, props: CloudFrontToApiGatewayToLambdaProps);
Parameters
- scope
Construct
- id
string
- props
CloudFrontToApiGatewayToLambdaProps
Pattern Construct Props
| Name | Type | Description |
|:-------------|:----------------|-----------------|
|deployLambda|boolean
|Whether to create a new Lambda function or use an existing Lambda function|
|existingLambdaObj?|lambda.Function
|Existing instance of Lambda Function object|
|lambdaFunctionProps?|lambda.FunctionProps
|Optional user provided props to override the default props for Lambda function|
|apiGatewayProps?|api.LambdaRestApiProps
|Optional user provided props to override the default props for API Gateway|
|cloudFrontDistributionProps?|cloudfront.CloudFrontWebDistributionProps
|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 resonses from cloudfront|
Pattern Properties
| Name | Type | Description |
|:-------------|:----------------|-----------------|
|cloudFrontWebDistribution()|cloudfront.CloudFrontWebDistribution
|Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct|
|lambdaFunction()|lambda.Function
|Returns an instance of the Lambda function created by the pattern.|
|restApi()|api.RestApi
|Returns an instance of the API Gateway REST API created by the pattern.|
Architecture
© Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.