Skip to main content

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/
Language Package
Python Logo{: style="height:16px;width:16px"} Python aws_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

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 resonses from cloudfront

Pattern Properties

Name Type Description
cloudFrontWebDistribution() cloudfront.CloudFrontWebDistribution Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct
restApi() api.RestApi Returns 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.

Release files for aws-solutions-konstruk.aws-cloudfront-apigateway 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aws-solutions-konstruk.aws-cloudfront-apigateway 0.8.1
File Size Uploaded
aws-solutions-konstruk.aws-cloudfront-apigateway-0.8.1.tar.gz 126.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aws-solutions-konstruk.aws-cloudfront-apigateway 0.8.1
File Interpreter ABI Platform
aws_solutions_konstruk.aws_cloudfront_apigateway-0.8.1-py3-none-any.whl Python 3 none any Details

Total release size: 252.4 kB

Release files / aws-solutions-konstruk.aws-cloudfront-apigateway-0.8.1.tar.gz

Download URL aws-solutions-konstruk.aws-cloudfront-apigateway-0.8.1.tar.gz
Size 126.8 kB
Tags Source
SHA-256 checksum
How to use checksums
d512eeb687013de6e7b17026129a8fc0bc29514e3453594e6d9dbd758896d1ca
BLAKE2b-256 checksum
How to use checksums
09892981b00b563d830319be22f3162a437e3ef9a42c12c5f9a0c6bcd2bc95ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release files / aws_solutions_konstruk.aws_cloudfront_apigateway-0.8.1-py3-none-any.whl

Download URL aws_solutions_konstruk.aws_cloudfront_apigateway-0.8.1-py3-none-any.whl
Size 125.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e7a57efda3f3e4fae2bddd0f867d26ba0c5b63d64a879e07ddfe4197a5de651b
BLAKE2b-256 checksum
How to use checksums
8013b015cec39903f48f266fe9b69bc6cda6644d1df43f861b3631e5480e6350
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.6

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page