Terraform module to easily provision CloudFront CDN backed by an S3 origin
Clone or download

README.md

README Header

Cloud Posse

terraform-aws-cloudfront-s3-cdn Build Status Latest Release Slack Community

Terraform module to provision an AWS CloudFront CDN with an S3 origin.


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

Terraform Open Source Modules

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

module "cdn" {
  source           = "git::https://github.com/cloudposse/terraform-aws-cloudfront-s3-cdn.git?ref=master"
  namespace        = "eg"
  stage            = "prod"
  name             = "app"
  aliases          = ["assets.cloudposse.com"]
  parent_zone_name = "cloudposse.com"
}

Full working example can be found in example folder.

Generating ACM Certificate

Use the AWS cli to request new ACM certifiates (requires email validation)

aws acm request-certificate --domain-name example.com --subject-alternative-names a.example.com b.example.com *.c.example.com

NOTE:

Although AWS Certificate Manager is supported in many AWS regions, to use an SSL certificate with CloudFront, it should be requested only in US East (N. Virginia) region.

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cnames-and-https-requirements.html

If you want to require HTTPS between viewers and CloudFront, you must change the AWS region to US East (N. Virginia) in the AWS Certificate Manager console before you request or import a certificate.

https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html

To use an ACM Certificate with Amazon CloudFront, you must request or import the certificate in the US East (N. Virginia) region. ACM Certificates in this region that are associated with a CloudFront distribution are distributed to all the geographic locations configured for that distribution.

This is a fundamental requirement of CloudFront, and you will need to request the certificate in us-east-1 region.

If there are warnings around the outputs when destroying using this module. Then you can use this method for supressing the superfluous errors. TF_WARN_OUTPUT_ERRORS=1 terraform destroy

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
acm_certificate_arn Existing ACM Certificate ARN string `` no
aliases List of FQDN's - Used to set the Alternate Domain Names (CNAMEs) setting on Cloudfront list <list> no
allowed_methods List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD) for AWS CloudFront list <list> no
attributes Additional attributes (e.g. 1) list <list> no
bucket_domain_format Format of bucket domain name string %s.s3.amazonaws.com no
cached_methods List of cached methods (e.g. GET, PUT, POST, DELETE, HEAD) list <list> no
comment Comment for the origin access identity string Managed by Terraform no
compress Compress content for web requests that include Accept-Encoding: gzip in the request header string false no
cors_allowed_headers List of allowed headers for S3 bucket list <list> no
cors_allowed_methods List of allowed methods (e.g. GET, PUT, POST, DELETE, HEAD) for S3 bucket list <list> no
cors_allowed_origins List of allowed origins (e.g. example.com, test.com) for S3 bucket list <list> no
cors_expose_headers List of expose header in the response for S3 bucket list <list> no
cors_max_age_seconds Time in seconds that browser can cache the response for S3 bucket string 3600 no
custom_error_response List of one or more custom error response element maps list <list> no
default_root_object Object that CloudFront return when requests the root URL string index.html no
default_ttl Default amount of time (in seconds) that an object is in a CloudFront cache string 60 no
delimiter Delimiter to be used between namespace, stage, name and attributes string - no
enabled Select Enabled if you want CloudFront to begin processing requests as soon as the distribution is created, or select Disabled if you do not want CloudFront to begin processing requests after the distribution is created. string true no
forward_cookies Time in seconds that browser can cache the response for S3 bucket string none no
forward_header_values A list of whitelisted header values to forward to the origin list <list> no
forward_query_string Forward query strings to the origin that is associated with this cache behavior string false no
geo_restriction_locations List of country codes for which CloudFront either to distribute content (whitelist) or not distribute your content (blacklist) list <list> no
geo_restriction_type Method that use to restrict distribution of your content by country: none, whitelist, or blacklist string none no
is_ipv6_enabled State of CloudFront IPv6 string true no
log_expiration_days Number of days after which to expunge the objects string 90 no
log_glacier_transition_days Number of days after which to move the data to the glacier storage tier string 60 no
log_include_cookies Include cookies in access logs string false no
log_prefix Path of logs in S3 bucket string `` no
log_standard_transition_days Number of days to persist in the standard storage tier before moving to the glacier tier string 30 no
max_ttl Maximum amount of time (in seconds) that an object is in a CloudFront cache string 31536000 no
min_ttl Minimum amount of time that you want objects to stay in CloudFront caches string 0 no
minimum_protocol_version Cloudfront TLS minimum protocol version string TLSv1 no
name Name (e.g. bastion or app) string - yes
namespace Namespace (e.g. eg or cp) string - yes
null an empty string string `` no
origin_bucket Name of S3 bucket string `` no
origin_force_destroy Delete all objects from the bucket so that the bucket can be destroyed without error (e.g. true or false) string false no
origin_path An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. It must begin with a /. Do not add a / at the end of the path. string `` no
parent_zone_id ID of the hosted zone to contain this record (or specify parent_zone_name) string `` no
parent_zone_name Name of the hosted zone to contain this record (or specify parent_zone_id) string `` no
price_class Price class for this distribution: PriceClass_All, PriceClass_200, PriceClass_100 string PriceClass_100 no
stage Stage (e.g. prod, dev, staging) string - yes
static_s3_bucket aws-cli is a bucket owned by amazon that will perminantly exist. It allows for the data source to be called during the destruction process without failing. It doesn't get used for anything else, this is a safe workaround for handling the fact that if a data source like the one aws_s3_bucket.selected gets an error, you can't continue the terraform process which also includes the 'destroy' command, where is doesn't even need this data source! Don't change this bucket name, it's a variable so that we can provide this description. And this works around a problem that is an edge case. string aws-cli no
tags Additional tags (e.g. map(BusinessUnit,XYZ) map <map> no
use_regional_s3_endpoint When set to 'true' the s3 origin_bucket will use the regional endpoint address instead of the global endpoint address string false no
viewer_protocol_policy allow-all, redirect-to-https string redirect-to-https no

Outputs

Name Description
cf_arn ARN of AWS CloudFront distribution
cf_domain_name Domain name corresponding to the distribution
cf_etag Current version of the distribution's information
cf_hosted_zone_id CloudFront Route 53 zone ID
cf_id ID of AWS CloudFront distribution
cf_status Current status of the distribution
s3_bucket Name of S3 bucket
s3_bucket_domain_name Domain of S3 bucket

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.

Help

Got a question?

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

README Commercial Support

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.

E-Mail

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

Newsletter

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.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. 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

Copyright © 2017-2018 Cloud Posse, LLC

License

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!

Cloud Posse

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
Erik Osterman
Andriy Knysh
Andriy Knysh
Jamie Nelson
Jamie Nelson
Clive Zagno
Clive Zagno

README Footer Beacon