CDK Constructs for AWS Cloudfront to AWS S3 integration.
Project description
aws-cloudfront-s3 module
---Reference Documentation: | https://docs.aws.amazon.com/solutions/latest/constructs/ |
---|
Language | Package |
---|---|
Python | aws_solutions_constructs.aws_cloudfront_s3 |
Typescript | @aws-solutions-constructs/aws-cloudfront-s3 |
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
- scope
Construct
- id
string
- props
CloudFrontToS3Props
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
© 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-s3-2.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5a21b0b9b7c2e7a8b5a084910f26daa57a342328e9e9976f193edd19510f4b83 |
|
MD5 | 70ad066bcd27ef54306c1239da8794e4 |
|
BLAKE2b-256 | 4786846b740c406829f821cea2e6c405715fcbebc929e422f4a3a399b4880e0a |
Close
Hashes for aws_solutions_constructs.aws_cloudfront_s3-2.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6aa78349dc22053d47334a6d3e2db963b7c8f15d200474dbe4845fd072d44cba |
|
MD5 | 130e1a466a58c6d9c6652ba1f7f21e4f |
|
BLAKE2b-256 | 5697bb0f413c1095a042540f29cb052f24fee573596bafe210a237ebbf1e269b |