CDK Constructs for AWS Cloudfront to AWS API Gateway integration.
Project description
aws-cloudfront-apigateway module
---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 in Typescript:
import * as api from '@aws-cdk/aws-apigateway';
import * as lambda from "@aws-cdk/aws-lambda";
import { CloudFrontToApiGateway } from '@aws-solutions-constructs/aws-cloudfront-apigateway';
const lambdaProps: lambda.FunctionProps = {
code: lambda.Code.fromAsset(`${__dirname}/lambda`),
runtime: lambda.Runtime.NODEJS_14_X,
handler: 'index.handler'
};
const lambdafunction = new lambda.Function(this, 'LambdaFunction', lambdaProps);
const apiGatewayProps: api.LambdaRestApiProps = {
handler: lambdafunction,
endpointConfiguration: {
types: [api.EndpointType.REGIONAL]
},
defaultMethodOptions: {
authorizationType: api.AuthorizationType.NONE
}
};
const apiGateway = new api.LambdaRestApi(this, 'LambdaRestApi', apiGatewayProps);
new CloudFrontToApiGateway(this, 'test-cloudfront-apigateway', {
existingApiGatewayObj: apiGateway
});
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.DistributionProps | any |
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 responses from CloudFront |
cloudFrontLoggingBucketProps? | s3.BucketProps |
Optional user provided props to override the default props for the CloudFront Logging Bucket. |
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. |
cloudFrontFunction? | cloudfront.Function |
Returns an instance of the Cloudfront function created by the pattern. |
cloudFrontLoggingBucket | s3.Bucket |
Returns an instance of the logging bucket for CloudFront WebDistribution. |
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
- Enable X-Ray Tracing
Architecture
© Copyright 2021 Amazon.com, Inc. or its affiliates. All Rights Reserved.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for aws-solutions-constructs.aws-cloudfront-apigateway-1.138.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ca295c910fdf50d2e75ce36be6b0eb227dae8c753faf83bc22c734b2672b1a0d |
|
MD5 | 3205c8381d1e2a485dae702cb344d812 |
|
BLAKE2b-256 | 95caa2fd3081b505c33872bc6572e4d6f690d48977fbf62c9a893b4a2b88ab79 |
Close
Hashes for aws_solutions_constructs.aws_cloudfront_apigateway-1.138.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c01f2e79b9197c99b3730c2b7aeeee8db85ae89621ee2ae2488535ff9b437c9c |
|
MD5 | e73c3259ea0de782df76177dc72f4caf |
|
BLAKE2b-256 | 95d5a0a9df393c0b4b0514d9d7d62c59e96ac52b7c597da0b83b0cbea59d5008 |