Skip to main content

CDK Constructs for AWS Cloudfront to AWS S3 integration.

Project description

aws-cloudfront-s3 module

---

Stability: Stable


Reference Documentation: https://docs.aws.amazon.com/solutions/latest/constructs/
Language Package
Python Logo Python aws_solutions_constructs.aws_cloudfront_s3
Typescript Logo Typescript @aws-solutions-constructs/aws-cloudfront-s3
Java Logo Java software.amazon.awsconstructs.services.cloudfronts3

This AWS Solutions Construct implements an AWS CloudFront fronting an AWS S3 Bucket.

Here is a minimal deployable pattern definition in Typescript:

import { CloudFrontToS3 } from '@aws-solutions-constructs/aws-cloudfront-s3';

new CloudFrontToS3(this, 'test-cloudfront-s3', {});

Initializer

new CloudFrontToS3(scope: Construct, id: string, props: CloudFrontToS3Props);

Parameters

Pattern Construct Props

Name Type Description
existingBucketObj? s3.IBucket Existing instance of S3 Bucket object or interface. If this is provided, then also providing bucketProps will cause an error.
bucketProps? s3.BucketProps Optional user provided props to override the default props for the S3 Bucket.
cloudFrontDistributionProps? cloudfront.DistributionProps 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
originPath? string Optional user provided props to provide anoriginPath that CloudFront appends to the origin domain name when CloudFront requests content from the origin. The string should start with a /, for example: /production. Default value is '/'
loggingBucketProps? s3.BucketProps Optional user provided props to override the default props for the S3 Logging Bucket.
cloudFrontLoggingBucketProps? s3.BucketProps Optional user provided props to override the default props for the CloudFront Logging Bucket.
logS3AccessLogs? boolean Whether to turn on Access Logging for the S3 bucket. Creates an S3 bucket with associated storage costs for the logs. Enabling Access Logging is a best practice. default - true

Pattern Properties

Name Type Description
cloudFrontWebDistribution cloudfront.CloudFrontWebDistribution Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct
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.
s3BucketInterface s3.IBucket Returns an instance of s3.IBucket created by the construct
s3Bucket? s3.Bucket Returns an instance of s3.Bucket created by the construct. IMPORTANT: If existingBucketObj was provided in Pattern Construct Props, this property will be undefined
s3LoggingBucket? s3.Bucket Returns an instance of s3.Bucket created by the construct as the logging bucket for the primary bucket.

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
  • CloudFront originPath set to '/'

Amazon S3 Bucket

  • Configure Access logging for S3 Bucket
  • Enable server-side encryption for S3 Bucket using AWS managed KMS Key
  • Enforce encryption of data in transit
  • Turn on the versioning for S3 Bucket
  • Don't allow public access for S3 Bucket
  • Retain the S3 Bucket when deleting the CloudFormation stack
  • Applies Lifecycle rule to move noncurrent object versions to Glacier storage after 90 days

Architecture

Architecture Diagram


© 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

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file aws-solutions-constructs.aws-cloudfront-s3-2.4.0.tar.gz.

File metadata

  • Download URL: aws-solutions-constructs.aws-cloudfront-s3-2.4.0.tar.gz
  • Upload date:
  • Size: 151.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.5

File hashes

Hashes for aws-solutions-constructs.aws-cloudfront-s3-2.4.0.tar.gz
Algorithm Hash digest
SHA256 75766d5ff2e0b550569337fb1996186cb684e47f6eef2af99b0c8a7868f8610b
MD5 687e711d65cd41b28d2958e5f9fc98ec
BLAKE2b-256 a6701ed3d0eb81b82aa8b185ea906fc379dd3fe7fe33cb522b9eca51382c49a4

See more details on using hashes here.

File details

Details for the file aws_solutions_constructs.aws_cloudfront_s3-2.4.0-py3-none-any.whl.

File metadata

  • Download URL: aws_solutions_constructs.aws_cloudfront_s3-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 149.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.63.1 importlib-metadata/4.8.3 keyring/23.4.1 rfc3986/1.5.0 colorama/0.4.4 CPython/3.6.5

File hashes

Hashes for aws_solutions_constructs.aws_cloudfront_s3-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9cb1fd7f66905369c6ae7804024575d3745d9ad0428dd279b679dd4662e9221e
MD5 1a25465de4bd648316689150e30778d9
BLAKE2b-256 9f617c8eadf7bd28e8b1fcb0a0fe004b69fcebc2ba701e5b90b40bf49cf28394

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page