terraform-aws-s3-website

Terraform module to provision S3-backed Websites

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!

Usage

IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases. Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.

Create s3 website bucket

module "website" {
  source    = "git::https://github.com/cloudposse/terraform-aws-s3-website.git?ref=master"
  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         = "git::https://github.com/cloudposse/terraform-aws-s3-website.git?ref=master"
  namespace      = "eg"
  stage          = "prod"
  name           = "app"
  hostname       = "docs.prod.cloudposse.org"
  parent_zone_id = "XXXXXXXXXXXX"
}

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. `policy` or `role`)	list(string)	`<list>`	no
cors_allowed_headers	List of allowed headers	list(string)	`<list>`	no
cors_allowed_methods	List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD)	list(string)	`<list>`	no
cors_allowed_origins	List of allowed origins (e.g. example.com, test.com)	list(string)	`<list>`	no
cors_expose_headers	List of expose header in the response	list(string)	`<list>`	no
cors_max_age_seconds	Time in seconds that browser can cache the response	number	`3600`	no
delimiter	Delimiter to be used between `name`, `namespace`, `stage`, etc.	string	`-`	no
deployment_actions	List of actions to permit deployment ARNs to perform	list(string)	`<list>`	no
deployment_arns	(Optional) Map of deployment ARNs to lists of S3 path prefixes to grant `deployment_actions` permissions	map(string)	`<map>`	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	-	yes
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
lifecycle_rule_enabled	Enable or disable lifecycle rule	bool	`false`	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	The Name of the application or solution (e.g. `bastion` or `portal`)	string	-	yes
namespace	Namespace (e.g. `eg` or `cp`)	string	``	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
region	AWS region this bucket should reside in	string	``	no
replication_source_principal_arns	(Optional) List of principal ARNs to grant replication access from different AWS accounts	list(string)	`<list>`	no
routing_rules	A json array containing routing rules describing redirect behavior and when redirects are applied	string	``	no
stage	Stage (e.g. `prod`, `dev`, `staging`)	string	``	no
tags	Additional tags (e.g. `map('BusinessUnit','XYZ')`)	map(string)	`<map>`	no
versioning_enabled	Enable or disable versioning	bool	`false`	no

Outputs

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

Share the Love

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Related Projects

Check out these related projects.

terraform-aws-cloudfront-s3-cdn - Terraform module to easily provision CloudFront CDN backed by an S3 origin
terraform-aws-s3-log-storage - This module creates an S3 bucket suitable for receiving logs from other AWS services such as S3, CloudFront, and CloudTrail
terraform-aws-user-data-s3-backend - Terraform Module to Offload User Data to S3
terraform-aws-s3-logs-athena-query - A Terraform module that creates an Athena Database and Structure for querying S3 access logs
terraform-aws-lb-s3-bucket - Terraform module to provision an S3 bucket with built in IAM policy to allow AWS Load Balancers to ship access logs

References

For additional context, refer to some of these links.

Hosting Websites on Amazon S3 - Example: setting up a Static Website Using a Custom Domain

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

Questions. We'll use a Shared Slack channel between your team and ours.
Troubleshooting. We'll help you triage why things aren't working.
Code Reviews. We'll review your Pull Requests and provide constructive feedback.
Bug Fixes. We'll rapidly work to fix any bugs in our projects.
Build New Terraform Modules. We'll develop original modules to provision infrastructure.
Cloud Architecture. We'll assist with your cloud strategy and design.
Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Signup for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright

License

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Contributors

Erik Osterman	Andriy Knysh	Vladimir

JaviOverflow/terraform-aws-s3-website