Module: LambdaSharp.App.Bucket

Version: 0.8.3.5

Overview

The LambdaSharp.App.Bucket module is used by the App declaration to create an S3 bucket for deploying the app files. The S3 bucket can either be configured for public access as a website or for secure access from a CloudFront distribution.

Resource Types

This module defines no resource types.

Parameters

CloudFrontOriginAccessIdentity

The CloudFrontOriginAccessIdentity parameter configures the S3 bucket for secure access from a CloudFront distribution. When left empty, the S3 bucket is configured as a public website instead.

Required: Yes

Type: String

The ContentEncoding parameter sets the content encoding to apply to all files copied from the zip package. The value must be one of: NONE, BROTLI, GZIP, or DEFAULT.

The encoded files are annotated with a Content-Encoding header matching the compression algorithm.

Required: Yes

Type: String

The ContentEncoding parameter must have one of the following values:

NONE

No content encoding is performed and no Content-Encoding header is applied. Using no encoding is fastest to perform, but produces significantly larger files.

BROTLI

Content is encoded with Brotli compression using the optimal compression setting. Brotli compression takes longer to perform, but produces smaller files.

Note that Brotli encoding is only valid for https:// connections.

GZIP

Content is encoded with Gzip compression. Gzip compression is faster than Brotli, but produces slightly larger files.

DEFAULT

The DEFAULT value defaults to BROTLI when a non-empty CloudFrontOriginAccessIdentity parameter is specified since CloudFront distributions are always served over https:// connections. Otherwise, it defaults to GZIP, which is safe for connections over https:// and http://.

Package

The Package parameter is the path to the packaged app files in the deployment bucket.

Required: Yes

Type: String

Output Values

Arn

The Arn output contains the ARN of the S3 bucket.

Type: AWS::S3::Bucket

DomainName

The DomainName output contains the IPv4 DNS name of the S3 bucket.

Type: String

WebsiteUrl

The WebsiteUrl output contains the Amazon S3 website endpoint of the S3 bucket.

Type: String