0.8.1 • Published 4 years ago

@aws-solutions-konstruk/aws-cloudfront-apigateway v0.8.1

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
4 years ago

aws-cloudfront-apigateway module


Stability: Experimental

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/
LanguagePackage
Python Logo{: style="height:16px;width:16px"} Pythonaws_solutions_konstruk.aws_cloudfront_apigateway
Typescript Logo{: style="height:16px;width:16px"} Typescript@aws-solutions-konstruk/aws-cloudfront-apigateway

This AWS Solutions Konstruk implements an AWS Cloudfront fronting an Amazon API Gateway REST API.

Here is a minimal deployable pattern definition:

const { defaults } = require('@aws-solutions-konstruk/core');
const { CloudFrontToApiGateway } = require('@aws-solutions-konstruk/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

Pattern Construct Props

NameTypeDescription
existingApiGatewayObjapi.RestApiThe regional API Gateway that will be fronted with the CloudFront
cloudFrontDistributionProps?cloudfront.CloudFrontWebDistributionProps | anyOptional 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 resonses from cloudfront

Pattern Properties

NameTypeDescription
cloudFrontWebDistribution()cloudfront.CloudFrontWebDistributionReturns an instance of cloudfront.CloudFrontWebDistribution created by the construct
restApi()api.RestApiReturns an instance of the API Gateway REST API created by the pattern.

Architecture

Architecture Diagram


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