Categorygithub.com/christian-korneck/awssc-go-dist/awssolutionsconstructsawscloudfronts3/v2

# Packages

No description provided by the author

# README

aws-cloudfront-s3 module


Stability: Stable


Reference Documentation:https://docs.aws.amazon.com/solutions/latest/constructs/
LanguagePackage
Python Logo Pythonaws_solutions_constructs.aws_cloudfront_s3
Typescript Logo Typescript@aws-solutions-constructs/aws-cloudfront-s3
Java Logo Javasoftware.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

NameTypeDescription
existingBucketObj?s3.IBucketExisting instance of S3 Bucket object or interface. If this is provided, then also providing bucketProps will cause an error.
bucketProps?s3.BucketPropsOptional user provided props to override the default props for the S3 Bucket.
cloudFrontDistributionProps?cloudfront.DistributionPropsOptional user provided props to override the default props for CloudFront Distribution
insertHttpSecurityHeaders?booleanOptional user provided props to turn on/off the automatic injection of best practice HTTP security headers in all responses from CloudFront
originPath?stringOptional 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.BucketPropsOptional user provided props to override the default props for the S3 Logging Bucket.
cloudFrontLoggingBucketProps?s3.BucketPropsOptional user provided props to override the default props for the CloudFront Logging Bucket.
logS3AccessLogs?booleanWhether 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

NameTypeDescription
cloudFrontWebDistributioncloudfront.CloudFrontWebDistributionReturns an instance of cloudfront.CloudFrontWebDistribution created by the construct
cloudFrontFunction?cloudfront.FunctionReturns an instance of the Cloudfront function created by the pattern.
cloudFrontLoggingBuckets3.BucketReturns an instance of the logging bucket for CloudFront WebDistribution.
s3BucketInterfaces3.IBucketReturns an instance of s3.IBucket created by the construct
s3Bucket?s3.BucketReturns 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.BucketReturns 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.