Module: `s3-website~~ OBSOLETE`

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"
}

Variables

Required Variables

hostname (string) required: Name of website bucket in fqdn format (e.g. test.example.com). IMPORTANT! Do not add trailing dot (.)

Optional Variables

allow_ssl_requests_only (bool) optional

Set to true to require requests to use Secure Socket Layer (HTTPS/SSL). This will explicitly deny access to HTTP requests

Default value: false

cors_allowed_headers (list(string)) optional

List of allowed headers

Default value:

[
  "*"
]

cors_allowed_methods (list(string)) optional

List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD)

Default value:

[
  "GET"
]

cors_allowed_origins (list(string)) optional

List of allowed origins (e.g. example.com, test.com)

Default value:

[
  "*"
]

cors_expose_headers (list(string)) optional

List of expose header in the response

Default value:

[
  "ETag"
]

cors_max_age_seconds (number) optional

Time in seconds that browser can cache the response

Default value: 3600

deployment_actions (list(string)) optional

List of actions to permit deployment ARNs to perform

Default value:

[
  "s3:PutObject",
  "s3:PutObjectAcl",
  "s3:GetObject",
  "s3:DeleteObject",
  "s3:ListBucket",
  "s3:ListBucketMultipartUploads",
  "s3:GetBucketLocation",
  "s3:AbortMultipartUpload"
]

deployment_arns (map(any)) optional

(Optional) Map of deployment ARNs to lists of S3 path prefixes to grant deployment_actions permissions

Default value: { }

encryption_enabled (bool) optional

When set to 'true' the resource will have AES256 encryption enabled by default

Default value: false

error_document (string) optional

An absolute path to the document to return in case of a 4XX error

Default value: "404.html"

force_destroy (bool) optional

Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. true or false)

Default value: false

index_document (string) optional

Amazon S3 returns this index document when requests are made to the root domain or any of the subfolders

Default value: "index.html"

lifecycle_rule_enabled (bool) optional

Enable or disable lifecycle rule

Default value: false

logs_enabled (bool) optional

Enable logs for s3 bucket

Default value: true

logs_expiration_days (number) optional

Number of days after which to expunge the objects

Default value: 90

logs_glacier_transition_days (number) optional

Number of days after which to move the data to the glacier storage tier

Default value: 60

logs_standard_transition_days (number) optional

Number of days to persist in the standard storage tier before moving to the glacier tier

Default value: 30

noncurrent_version_expiration_days (number) optional

Specifies when noncurrent object versions expire

Default value: 90

noncurrent_version_transition_days (number) optional

Number of days to persist in the standard storage tier before moving to the glacier tier infrequent access tier

Default value: 30

parent_zone_id (string) optional

ID of the hosted zone to contain the record

Default value: ""

parent_zone_name (string) optional

Name of the hosted zone to contain the record

Default value: ""

prefix (string) optional

Prefix identifying one or more objects to which the rule applies

Default value: ""

redirect_all_requests_to (string) optional

A hostname to redirect all website requests for this bucket to. If this is set index_document will be ignored

Default value: ""

replication_source_principal_arns (list(string)) optional

(Optional) List of principal ARNs to grant replication access from different AWS accounts

Default value: [ ]

routing_rules (string) optional

A json array containing routing rules describing redirect behavior and when redirects are applied

Default value: ""

versioning_enabled (bool) optional

Enable or disable versioning

Default value: true

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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

Dependencies

Requirements

terraform, version: >= 1.0
aws, version: >= 4.9
local, version: >= 1.2

Providers

aws, version: >= 4.9

Modules

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

Resources

The following resources are used by this module:

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)

Data Sources

The following data sources are used by this module:

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)

Module: s3-website~~ OBSOLETE

Deprecated​

Usage​

Create s3 website bucket​

Create S3 website bucket with Route53 DNS​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `s3-website~~ OBSOLETE`

Deprecated

Usage

Create s3 website bucket

Create S3 website bucket with Route53 DNS

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources