terraform-aws-cloudfront-cdn

Terraform Module that implements a CloudFront Distribution (CDN) for a custom origin (e.g. website) and ships logs to a bucket.

If you need to accelerate an S3 bucket, we suggest using terraform-aws-cloudfront-s3-cdn instead.

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: We do not pin modules to versions in our examples because of the difficulty of keeping the versions in the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way so that they do not catch you by surprise.

Also, because of a bug in the Terraform registry (hashicorp/terraform#21417), the registry shows many of our inputs as required when in fact they are optional. The table below correctly indicates which inputs are required.

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

module "cdn" {
  source = "cloudposse/cloudfront-cdn/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace          = "eg"
  stage              = "prod"
  name               = "app"
  aliases            = ["www.example.net"]
  origin_domain_name = "origin.example.com"
  parent_zone_name   = "example.net"
}

Complete example of setting up CloudFront Distribution with Cache Behaviors for a WordPress site: examples/wordpress

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

Makefile Targets

Available targets:

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

Requirements

Name	Version
terraform	>= 0.12.26
aws	>= 2.0
local	>= 1.2

Providers

Name	Version
aws	>= 2.0

Inputs

Name	Description	Type	Default	Required
acm_certificate_arn	Existing ACM Certificate ARN	`string`	`""`	no
additional_tag_map	Additional tags for appending to tags_as_list_of_maps. Not added to `tags`.	`map(string)`	`{}`	no
aliases	List of aliases. CAUTION! Names MUSTN'T contain trailing `.`	`list(string)`	`[]`	no
allowed_methods	List of allowed methods (e.g. `GET, PUT, POST, DELETE, HEAD`) for AWS CloudFront	`list(string)`	[ "DELETE", "GET", "HEAD", "OPTIONS", "PATCH", "POST", "PUT" ]	no
attributes	Additional attributes (e.g. `1`)	`list(string)`	`[]`	no
cached_methods	List of cached methods (e.g. `GET, PUT, POST, DELETE, HEAD`)	`list(string)`	[ "GET", "HEAD" ]	no
comment	Comment for the origin access identity	`string`	`"Managed by Terraform"`	no
compress	Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header (default: false)	`bool`	`false`	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.	object({ enabled = bool namespace = string environment = string stage = string name = string delimiter = string attributes = list(string) tags = map(string) additional_tag_map = map(string) regex_replace_chars = string label_order = list(string) id_length_limit = number })	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "enabled": true, "environment": null, "id_length_limit": null, "label_order": [], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {} }	no
custom_error_response	List of one or more custom error response element maps	list(object({ error_caching_min_ttl = string error_code = string response_code = string response_page_path = string }))	`[]`	no
custom_header	List of one or more custom headers passed to the origin	list(object({ name = string value = string }))	`[]`	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	`number`	`60`	no
delimiter	Delimiter to be used between `namespace`, `environment`, `stage`, `name` and `attributes`. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
distribution_enabled	Set to `true` if you want CloudFront to begin processing requests as soon as the distribution is created, or to false if you do not want CloudFront to begin processing requests after the distribution is created.	`bool`	`true`	no
dns_aliases_enabled	Set to false to prevent dns records for aliases from being created	`bool`	`true`	no
enabled	Set to false to prevent the module from creating any resources	`bool`	`null`	no
environment	Environment, e.g. 'uw2', 'us-west-2', OR 'prod', 'staging', 'dev', 'UAT'	`string`	`null`	no
forward_cookies	Specifies whether you want CloudFront to forward cookies to the origin. Valid options are all, none or whitelist	`string`	`"none"`	no
forward_cookies_whitelisted_names	List of forwarded cookie names	`list(string)`	`[]`	no
forward_headers	Specifies the Headers, if any, that you want CloudFront to vary upon for this cache behavior. Specify `*` to include all headers.	`list(string)`	`[]`	no
forward_query_string	Forward query strings to the origin that is associated with this cache behavior	`bool`	`false`	no
geo_restriction_locations	List of country codes for which CloudFront either to distribute content (whitelist) or not distribute your content (blacklist)	`list(string)`	`[]`	no
geo_restriction_type	Method that use to restrict distribution of your content by country: `none`, `whitelist`, or `blacklist`	`string`	`"none"`	no
id_length_limit	Limit `id` to this many characters. Set to `0` for unlimited length. Set to `null` for default, which is `0`. Does not affect `id_full`.	`number`	`null`	no
is_ipv6_enabled	State of CloudFront IPv6	`bool`	`true`	no
label_order	The naming order of the id output and Name tag. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 5 elements, but at least one must be present.	`list(string)`	`null`	no
log_bucket_fqdn	Optional fqdn of logging bucket, if not supplied a bucket will be generated.	`string`	`""`	no
log_expiration_days	Number of days after which to expunge the objects	`number`	`90`	no
log_glacier_transition_days	Number of days after which to move the data to the glacier storage tier	`number`	`60`	no
log_include_cookies	Include cookies in access logs	`bool`	`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	`number`	`30`	no
logging_enabled	When true, access logs will be sent to a newly created s3 bucket	`bool`	`true`	no
max_ttl	Maximum amount of time (in seconds) that an object is in a CloudFront cache	`number`	`31536000`	no
min_ttl	Minimum amount of time that you want objects to stay in CloudFront caches	`number`	`0`	no
name	Solution name, e.g. 'app' or 'jenkins'	`string`	`null`	no
namespace	Namespace, which could be your organization name or abbreviation, e.g. 'eg' or 'cp'	`string`	`null`	no
ordered_cache	An ordered list of cache behaviors resource for this distribution. List from top to bottom in order of precedence. The topmost cache behavior will have precedence 0. The fields can be described by the other variables in this file. For example, the field 'lambda_function_association' in this object has a description in var.lambda_function_association variable earlier in this file. The only difference is that fields on this object are in ordered caches, whereas the rest of the vars in this file apply only to the default cache. Put value `""` on field `target_origin_id` to specify default s3 bucket origin.	list(object({ target_origin_id = string path_pattern = string allowed_methods = list(string) cached_methods = list(string) compress = bool viewer_protocol_policy = string min_ttl = number default_ttl = number max_ttl = number forward_query_string = bool forward_header_values = list(string) forward_cookies = string lambda_function_association = list(object({ event_type = string include_body = bool lambda_arn = string })) }))	`[]`	no
origin_domain_name	The DNS domain name of your custom origin (e.g. website)	`string`	`""`	no
origin_http_port	The HTTP port the custom origin listens on	`number`	`"80"`	no
origin_https_port	The HTTPS port the custom origin listens on	`number`	`443`	no
origin_keepalive_timeout	The Custom KeepAlive timeout, in seconds. By default, AWS enforces a limit of 60. But you can request an increase.	`number`	`60`	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
origin_protocol_policy	The origin protocol policy to apply to your origin. One of http-only, https-only, or match-viewer	`string`	`"match-viewer"`	no
origin_read_timeout	The Custom Read timeout, in seconds. By default, AWS enforces a limit of 60. But you can request an increase.	`number`	`60`	no
origin_ssl_protocols	The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS	`list(string)`	[ "TLSv1", "TLSv1.1", "TLSv1.2" ]	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
regex_replace_chars	Regex to replace chars with empty string in `namespace`, `environment`, `stage` and `name`. If not set, `"/[^a-zA-Z0-9-]/"` is used to remove all characters other than hyphens, letters and digits.	`string`	`null`	no
stage	Stage, e.g. 'prod', 'staging', 'dev', OR 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `map('BusinessUnit','XYZ')`	`map(string)`	`{}`	no
trusted_signers	List of AWS account IDs (or self) that you want to allow to create signed URLs for private content	`list(string)`	`[]`	no
viewer_minimum_protocol_version	The minimum version of the SSL protocol that you want CloudFront to use for HTTPS connections.	`string`	`"TLSv1"`	no
viewer_protocol_policy	allow-all, redirect-to-https	`string`	`"redirect-to-https"`	no
web_acl_id	ID of the AWS WAF web ACL that is associated with the distribution	`string`	`""`	no

Outputs

Name	Description
cf_aliases	Extra CNAMEs of AWS CloudFront
cf_arn	ARN of 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 CloudFront distribution
cf_origin_access_identity	A shortcut to the full path for the origin access identity to use in CloudFront
cf_status	Current status of the distribution
logs	Logs resource

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-cloudtrail - Terraform module to provision an AWS CloudTrail and an encrypted S3 bucket with versioning to store CloudTrail logs
terraform-aws-s3-website - Terraform module to provision S3-backed websites
terraform-root-modules/aws/docs - Reference implementation combining terraform-aws-s3-website with terraform-aws-cdn

Help

Got a question? We got answers.

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

DevOps Accelerator for Startups

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

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

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

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.

Discourse Forums

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Newsletter

Sign up 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.

Office Hours

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

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	Igor Rodionov	Andriy Knysh	Justin Burnham

Name		Name	Last commit message	Last commit date
Latest commit History 25 Commits
.github		.github
docs		docs
examples		examples
test		test
.gitignore		.gitignore
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
README.yaml		README.yaml
context.tf		context.tf
main.tf		main.tf
outputs.tf		outputs.tf
variables.tf		variables.tf
versions.tf		versions.tf

License

liamhelmer/terraform-aws-cloudfront-cdn

Folders and files

Latest commit

History

Repository files navigation

terraform-aws-cloudfront-cdn

Usage

Generating ACM Certificate

Makefile Targets

Requirements

Providers

Inputs

Outputs

Share the Love

Related Projects

Help

DevOps Accelerator for Startups

Slack Community

Discourse Forums

Newsletter

Office Hours

Contributing

Bug Reports & Feature Requests

Developing

Copyright

License

Trademarks

About

Contributors

About

Resources

License

Stars

Watchers

Forks

Languages