@aws-solutions-constructs/aws-cloudfront-s3

v2.74.0

CDK Constructs for AWS Cloudfront to AWS S3 integration. For more information about how to use this package see README

Latest version published 18 days ago

License: Apache-2.0

NPM

GitHub

Package Health Score

81 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version			Vulnerabilities	License Risk
2.74.0	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.73.0	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.72.0	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.181.1	\|	12/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.23.0	\|	09/2022	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Yes

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (7,035)

GitHub Stars: 1.24K
Forks: 247
Contributors: 40

Direct Usage Popularity

The npm package @aws-solutions-constructs/aws-cloudfront-s3 receives a total of 7,035 downloads a week. As such, we scored @aws-solutions-constructs/aws-cloudfront-s3 popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @aws-solutions-constructs/aws-cloudfront-s3, we found that it has been starred 1,235 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 40
Funding: No

With more than 10 contributors for the @aws-solutions-constructs/aws-cloudfront-s3 repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 50
Open PR: 3
Last Release: 18 days ago
Last Commit: 12 days ago

Further analysis of the maintenance status of @aws-solutions-constructs/aws-cloudfront-s3 based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @aws-solutions-constructs/aws-cloudfront-s3 demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 4 Direct
Versions: 235
Install Size: 1.6 MB
Dist-tags: 2
# of Files: 153
Maintainers: 1
TS Typings: No

@aws-solutions-constructs/aws-cloudfront-s3 has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

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`

Overview

This AWS Solutions Construct provisions an Amazon CloudFront Distribution that serves objects from an AWS S3 Bucket via an Origin Access Control (OAC).

Here is a minimal deployable pattern definition:

Typescript

import { Construct } from 'constructs';
import { Stack, StackProps } from 'aws-cdk-lib';
import { CloudFrontToS3 } from '@aws-solutions-constructs/aws-cloudfront-s3';

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

Python

from aws_solutions_constructs.aws_cloudfront_s3 import CloudFrontToS3
from aws_cdk import Stack
from constructs import Construct

CloudFrontToS3(self, 'test-cloudfront-s3')

Java

import software.constructs.Construct;

import software.amazon.awscdk.Stack;
import software.amazon.awscdk.StackProps;
import software.amazon.awsconstructs.services.cloudfronts3.*;

new CloudFrontToS3(this, "test-cloudfront-s3", new CloudFrontToS3Props.Builder()
        .build());

Pattern Construct Props

Name	Type	Description
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
responseHeadersPolicyProps?	`cloudfront.ResponseHeadersPolicyProps`	Optional user provided configuration that cloudfront applies to all http responses.
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 `'/'`
existingBucketObj?	`s3.IBucket`	Existing instance of S3 content 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 content bucket. Note - to log S3 access for this bucket to an existing S3 bucket, put the existing log bucket in bucketProps: `serverAccessLogsBucket`
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
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. Note: to use an existing bucketto hold CloudFront logs, pass the existing log bucket in
logCloudFrontAccessLog	`boolean`	Optional - Whether to maintain access logs for the CloudFront Logging bucket. Specifying false for this while providing info about the log bucket will cause an error. Default = true
cloudFrontLoggingBucketAccessLogBucketProps	`s3.BucketProps`	Optional user provided props to override the default props for the CloudFront Log Bucket Access Log bucket. Providing both this and `existingcloudFrontLoggingBucketAccessLogBucket` will cause an error. To provide an existing bucket to accept these logs, pass the existing bucket in `cloudFrontLoggingBucketProps::serverAccessLogBucket`

Pattern Properties

Name	Type	Description
cloudFrontWebDistribution	`cloudfront.Distribution`	Returns an instance of cloudfront.Distribution created by the construct.
cloudFrontFunction?	`cloudfront.Function`	Returns an instance of the Cloudfront function created by the construct.
originAccessControl?	`cloudfront.CfnOriginAccessControl`	Returns an instance of cloudfront.CfnOriginAccessControl created by the construct.
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.
cloudFrontLoggingBucket?	`s3.Bucket`	The S3 bucket created by the construct to hold CloudFront logs. Only populated if the construct creates the bucket (not if an existing bucket is passed in via DistributionProps)
cloudFrontLoggingBucketAccessLogBucket?	`s3.Bucket`	The S3 bucket containing the S3 access logs for the CloudFront log bucket. Only populated if the construct creates the bucket (not if the bucket is passed in via `cloudFrontLoggingBucketProps::serverAccessLogBucket`

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 Distribution
Enable automatic injection of best practice HTTP security headers in all responses from CloudFront Distribution
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

@aws-solutions-constructs/aws-cloudfront-s3 dependencies

@aws-cdk/integ-tests-alpha @aws-solutions-constructs/core @aws-solutions-constructs/resources constructs

@aws-solutions-constructs/aws-cloudfront-s3 development dependencies

@types/jest @types/node constructs aws-cdk-lib

FAQs

What is @aws-solutions-constructs/aws-cloudfront-s3?

CDK Constructs for AWS Cloudfront to AWS S3 integration. Visit Snyk Advisor to see a full health score report for @aws-solutions-constructs/aws-cloudfront-s3, including popularity, security, maintenance & community analysis.

Is @aws-solutions-constructs/aws-cloudfront-s3 popular?

The npm package @aws-solutions-constructs/aws-cloudfront-s3 receives a total of 7,035 weekly downloads. As such, @aws-solutions-constructs/aws-cloudfront-s3 popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @aws-solutions-constructs/aws-cloudfront-s3 well maintained?

We found that @aws-solutions-constructs/aws-cloudfront-s3 demonstrated a healthy version release cadence and project activity. It has a community of 40 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @aws-solutions-constructs/aws-cloudfront-s3 safe to use?

The npm package @aws-solutions-constructs/aws-cloudfront-s3 was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 5 November-2024, at 05:20 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP