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:
Typescript
import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { CloudFrontToApiGateway } from '@aws-solutions-constructs/aws-cloudfront-apigateway';
import * as lambda from 'aws-cdk-lib/aws-lambda';
import * as api from 'aws-cdk-lib/aws-apigateway';
const lambdaProps: lambda.FunctionProps = {
code: lambda.Code.fromAsset(`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
});
Python
from aws_solutions_constructs.aws_cloudfront_apigateway import CloudFrontToApiGateway
from aws_cdk import (
aws_lambda as _lambda,
aws_apigateway as api,
Stack
)
from constructs import Construct
lambda_function = _lambda.Function(self, 'LambdaFunction',
code=_lambda.Code.from_asset(
'lambda'),
runtime=_lambda.Runtime.PYTHON_3_9,
handler='index.handler')
api_gateway = api.LambdaRestApi(self, 'LambdaRestApi',
handler=lambda_function,
endpoint_configuration=api.EndpointConfiguration(
types=[api.EndpointType.REGIONAL]
),
default_method_options=api.MethodOptions(
authorization_type=api.AuthorizationType.NONE
))
CloudFrontToApiGateway(self, 'test-cloudfront-apigateway',
existing_api_gateway_obj=api_gateway
)
Java
import software.constructs.Construct;
import java.util.List;
import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awscdk.services.lambda.*;
import software.amazon.awscdk.services.lambda.Runtime;
import software.amazon.awscdk.services.apigateway.*;
import software.amazon.awsconstructs.services.cloudfrontapigateway.*;
final Function lambdaFunction = Function.Builder.create(this, "IndexHandler")
.runtime(Runtime.NODEJS_14_X)
.code(Code.fromAsset("lambda"))
.handler("index.handler")
.build();
final LambdaRestApi apiGateway = LambdaRestApi.Builder.create(this, "myapi")
.handler(lambdaFunction)
.endpointConfiguration(new EndpointConfiguration.Builder()
.types(List.of(EndpointType.REGIONAL))
.build())
.build();
new CloudFrontToApiGateway(this, "test-cloudfront-apigateway", new CloudFrontToApiGatewayProps.Builder()
.existingApiGatewayObj(apiGateway)
.build());
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 2022 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.155.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2dd436dae96358303423fd5a6056b02b1c0b0c32ee7013c8f1ce97e86a56180 |
|
MD5 | 3314f93dc99ae6e8ce6bf18c0ccdef95 |
|
BLAKE2b-256 | 962577b3d2b33eebbfa1098432600245b866bc7e46c03f90b6026da437d84172 |
Close
Hashes for aws_solutions_constructs.aws_cloudfront_apigateway-1.155.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1209097f9d7cc2154c92ab4f18a1da61f00a41f103f3fdc105905d94f0a43b71 |
|
MD5 | 8bf441f6e3efc192a4a094671214984e |
|
BLAKE2b-256 | b5e0c0f0a7bc351756cbf19f2f2f227719d82027df24d7890e438d0a9581eb88 |