Module: s3-website

Deprecated

As of July, 2023 this module is deprecated. terraform-aws-s3-website offers little value beyond the terraform-aws-s3-bucket module, so Cloud Posse is phasing out support for this project. Users are advised to migrate to terraform-aws-s3-bucket to manage the S3 bucket (including logging) and terraform-aws-route53-alias to register the website hostname in Route53. Feature requests should be directed to those modules.

Terraform module to provision S3-backed Websites. IMPORTANT: This module provisions a globally accessible S3 bucket for unauthenticated users because it is designed for hosting public static websites. Normally, AWS recommends that S3 buckets should not publicly accessible in order to protect S3 data from unauthorized users.

Usage

Create s3 website bucket

module "website" {
  source = "cloudposse/s3-website/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  namespace = "eg"
  stage     = "prod"
  name      = "app"
  hostname  = "docs.prod.cloudposse.org"

  deployment_arns = {
    "arn:aws:s3:::principal1" = ["/prefix1", "/prefix2"]
    "arn:aws:s3:::principal2" = [""]
  }
}

Create S3 website bucket with Route53 DNS

Required one of the parent_zone_id or parent_zone_name

module "website_with_cname" {
  source = "cloudposse/s3-website/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"
  namespace      = "eg"
  stage          = "prod"
  name           = "app"
  hostname       = "docs.prod.cloudposse.org"
  parent_zone_id = "XXXXXXXXXXXX"
}

Requirements

Name	Version
terraform	>= 1.0
aws	>= 4.9
local	>= 1.2

Providers

Name	Version
aws	>= 4.9

Modules

Name	Source	Version
default_label	cloudposse/label/null	0.25.0
dns	cloudposse/route53-alias/aws	0.13.0
logs	cloudposse/s3-log-storage/aws	1.4.2
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_s3_bucket.default	resource
aws_s3_bucket_ownership_controls.s3_bucket_ownership_controls	resource
aws_s3_bucket_policy.default	resource
aws_s3_bucket_public_access_block.s3_allow_public_access	resource
aws_iam_policy_document.default	data source
aws_iam_policy_document.deployment	data source
aws_iam_policy_document.replication	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
allow_ssl_requests_only	Set to true to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requests	bool	false	no
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
cors_allowed_headers	List of allowed headers	list(string)	[ "*" ]	no
cors_allowed_methods	List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD)	list(string)	[ "GET" ]	no
cors_allowed_origins	List of allowed origins (e.g. example.com, test.com)	list(string)	[ "*" ]	no
cors_expose_headers	List of expose header in the response	list(string)	[ "ETag" ]	no
cors_max_age_seconds	Time in seconds that browser can cache the response	number	3600	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
deployment_actions	List of actions to permit deployment ARNs to perform	list(string)	[ "s3:PutObject", "s3:PutObjectAcl", "s3:GetObject", "s3:DeleteObject", "s3:ListBucket", "s3:ListBucketMultipartUploads", "s3:GetBucketLocation", "s3:AbortMultipartUpload" ]	no
deployment_arns	(Optional) Map of deployment ARNs to lists of S3 path prefixes to grant deployment_actions permissions	map(any)	{}	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
encryption_enabled	When set to 'true' the resource will have AES256 encryption enabled by default	bool	false	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
error_document	An absolute path to the document to return in case of a 4XX error	string	"404.html"	no
force_destroy	Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. true or false)	bool	false	no
hostname	Name of website bucket in fqdn format (e.g. test.example.com). IMPORTANT! Do not add trailing dot (.)	string	n/a	yes
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
index_document	Amazon S3 returns this index document when requests are made to the root domain or any of the subfolders	string	"index.html"	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
lifecycle_rule_enabled	Enable or disable lifecycle rule	bool	false	no
logs_enabled	Enable logs for s3 bucket	bool	true	no
logs_expiration_days	Number of days after which to expunge the objects	number	90	no
logs_glacier_transition_days	Number of days after which to move the data to the glacier storage tier	number	60	no
logs_standard_transition_days	Number of days to persist in the standard storage tier before moving to the glacier tier	number	30	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
noncurrent_version_expiration_days	Specifies when noncurrent object versions expire	number	90	no
noncurrent_version_transition_days	Number of days to persist in the standard storage tier before moving to the glacier tier infrequent access tier	number	30	no
parent_zone_id	ID of the hosted zone to contain the record	string	""	no
parent_zone_name	Name of the hosted zone to contain the record	string	""	no
prefix	Prefix identifying one or more objects to which the rule applies	string	""	no
redirect_all_requests_to	A hostname to redirect all website requests for this bucket to. If this is set index_document will be ignored	string	""	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
replication_source_principal_arns	(Optional) List of principal ARNs to grant replication access from different AWS accounts	list(string)	[]	no
routing_rules	A json array containing routing rules describing redirect behavior and when redirects are applied	string	""	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
versioning_enabled	Enable or disable versioning	bool	true	no

Outputs

Name	Description
hostname	Bucket hostname
s3_bucket_arn	ARN identifier of the website bucket
s3_bucket_domain_name	Name of the website bucket
s3_bucket_hosted_zone_id	The Route 53 Hosted Zone ID for this bucket's region
s3_bucket_name	DNS record of the website bucket
s3_bucket_website_domain	The domain of the website endpoint
s3_bucket_website_endpoint	The website endpoint URL