@aws-solutions-konstruk/aws-cloudfront-s3
v0.8.1
Published
CDK Constructs for AWS Cloudfront to AWS S3 integration.
Downloads
8
Readme
aws-cloudfront-s3 module
This is a developer preview (public beta) module.
All classes are under active development and subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.
| API Reference:| http://docs.awssolutionsbuilder.com/aws-solutions-konstruk/latest/api/aws-cloudfront-s3/| |:-------------|:-------------|
| Language | Package |
|:-------------|-----------------|
|{: style="height:16px;width:16px"} Python|aws_solutions_konstruk.aws_cloudfront_s3
|
|{: style="height:16px;width:16px"} Typescript|@aws-solutions-konstruk/aws-cloudfront-s3
|
This AWS Solutions Konstruk implements an AWS Cloudfront fronting an AWS S3 Bucket.
Here is a minimal deployable pattern definition:
const { CloudFrontToS3 } = require('@aws-solutions-konstruk/aws-cloudfront-s3');
new CloudFrontToS3(stack, 'test-cloudfront-s3', {
deployBucket: true
});
Initializer
new CloudFrontToS3(scope: Construct, id: string, props: CloudFrontToS3Props);
Parameters
- scope
Construct
- id
string
- props
CloudFrontToS3Props
Pattern Construct Props
| Name | Type | Description |
|:-------------|:----------------|-----------------|
|deployBucket|boolean
|Whether to create a S3 Bucket or use an existing S3 Bucket|
|existingBucketObj?|s3.Bucket
|Existing instance of S3 Bucket object|
|bucketProps?|s3.BucketProps
|Optional user provided props to override the default props for S3 Bucket|
|cloudFrontDistributionProps?|cloudfront.CloudFrontWebDistributionProps
|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 resonses from cloudfront|
Pattern Properties
| Name | Type | Description |
|:-------------|:----------------|-----------------|
|cloudFrontWebDistribution()|cloudfront.CloudFrontWebDistribution
|Returns an instance of cloudfront.CloudFrontWebDistribution created by the construct|
|bucket()|s3.Bucket
|Returns an instance of s3.Bucket created by the construct|
Architecture
© Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.