aws-solutions-constructs.aws-cloudfront-apigateway 1.46.0

CDK Constructs for AWS Cloudfront to AWS API Gateway integration.

aws-cloudfront-apigateway 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
Typescript	@aws-solutions-constructs/aws-cloudfront-apigateway
Java	software.amazon.awsconstructs.services.cloudfrontapigateway

This AWS Solutions Construct implements an AWS CloudFront fronting an Amazon API Gateway REST API.

Here is a minimal deployable pattern definition:

const { defaults } = require('@aws-solutions-constructs/core');
const { CloudFrontToApiGateway } = require('@aws-solutions-constructs/aws-cloudfront-apigateway');

const stack = new Stack();

const lambdaProps: lambda.FunctionProps = {
    code: lambda.Code.asset(`${__dirname}/lambda`),
    runtime: lambda.Runtime.NODEJS_12_X,
    handler: 'index.handler'
};

const func = defaults.deployLambdaFunction(stack, lambdaProps);

const _api = defaults.RegionalApiGateway(stack, func);

new CloudFrontToApiGateway(stack, 'test-cloudfront-apigateway', {
    existingApiGatewayObj: _api
});

Initializer

new CloudFrontToApiGateway(scope: Construct, id: string, props: CloudFrontToApiGatewayProps);

Parameters

• scope Construct
• id string
• props CloudFrontToApiGatewayProps

Pattern Construct Props

Name	Type	Description
existingApiGatewayObj	api.RestApi	The regional API Gateway that will be fronted with the CloudFront
cloudFrontDistributionProps?	[`cloudfront.CloudFrontWebDistributionProps	any`](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_aws-cloudfront.CloudFrontWebDistributionProps.html)
insertHttpSecurityHeaders?	boolean	Optional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from CloudFront

Pattern Properties

Name	Type	Description
cloudFrontWebDistribution	cloudfront.CloudFrontWebDistribution	Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct
apiGateway	api.RestApi	Returns an instance of the API Gateway REST API 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

• User provided API Gateway object is used as-is

Architecture

---

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