Nuclear Pizza Machine

    @aws-solutions-konstruk/aws-cloudfront-apigateway
    TypeScript icon, indicating that this package has built-in type declarations

    0.8.1 • Public • Published

    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.

    Keywords

    none

    Install

    npm i @aws-solutions-konstruk/aws-cloudfront-apigateway

    DownloadsWeekly Downloads

    33

    Version

    0.8.1

    License

    Apache-2.0

    Unpacked Size

    233 kB

    Total Files

    14

    Last publish

    Collaborators

    • aws-solutions-konstruk-support