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.
Basic usage:
module "cdn" {
source = "git::https://github.com/cloudposse/terraform-aws-cloudfront-cdn.git?ref=master"
namespace = "cp"
stage = "prod"
name = "app"
aliases = ["cloudposse.com", "www.cloudposse.com"]
parent_zone_name = "cloudposse.com"
origin_domain_name = "origin.cloudposse.com"
}Complete example of setting up CloudFront Distribution with Cache Behaviors for a WordPress site: examples/wordpress
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
Available targets:
help This help screen
help/all Display help for all targets
lint Lint terraform code
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| acm_certificate_arn | Existing ACM Certificate ARN | string | `` | no |
| aliases | List of aliases. CAUTION! Names MUSTN'T contain trailing . |
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. policy or role) |
list | <list> |
no |
| cache_behavior | List of cache behaviors to implement | list | <list> |
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 | (Optional) Whether you want CloudFront to automatically compress content for web requests that include Accept-Encoding: gzip in the request header (default: false) | string | false |
no |
| custom_error_response | (Optional) - 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 name, namespace, stage, etc. |
string | - |
no |
| dns_aliases_enabled | Set to false to prevent dns records for aliases from being created | string | true |
no |
| enabled | Set to false to prevent the module from creating any resources | string | true |
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 | <list> |
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 | <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 |
| name | Name (e.g. bastion or db) |
string | - | yes |
| namespace | Namespace (e.g. cp or cloudposse) |
string | - | yes |
| origin_domain_name | (Required) - The DNS domain name of your custom origin (e.g. website) | string | `` | no |
| origin_http_port | (Required) - The HTTP port the custom origin listens on | string | 80 |
no |
| origin_https_port | (Required) - The HTTPS port the custom origin listens on | string | 443 |
no |
| origin_keepalive_timeout | (Optional) The Custom KeepAlive timeout, in seconds. By default, AWS enforces a limit of 60. But you can request an increase. | string | 60 |
no |
| origin_path | (Optional) - An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin | string | `` | no |
| origin_protocol_policy | (Required) - 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 | (Optional) The Custom Read timeout, in seconds. By default, AWS enforces a limit of 60. But you can request an increase. | string | 60 |
no |
| origin_ssl_protocols | (Required) - The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS | list | <list> |
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 |
| tags | Additional tags (e.g. map('BusinessUnit','XYZ')) |
map | <map> |
no |
| viewer_minimum_protocol_version | (Optional) 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 | (Optional) - Web ACL ID that can be attached to the Cloudfront distribution | string | `` | no |
| Name | Description |
|---|---|
| cf_aliases | Extra CNAMEs of AWS CloudFront |
| cf_arn | ID 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_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 |
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-websitewithterraform-aws-cdn
Got a question?
File a GitHub issue, send us an email or join our Slack Community.
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.
Get access to our Open Source Community Forum on Slack. It's FREE to join 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 sweet infrastructure.
Please use the issue tracker to report any bugs or file feature requests.
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 © 2017-2018 Cloud Posse, LLC
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know at hello@cloudposse.com
We're a DevOps Professional Services company based in Los Angeles, CA. We love Open Source Software!
We offer paid support on all of our projects.
Check out our other projects, apply for a job, or hire us to help with your cloud strategy and implementation.
 Erik Osterman |
 Igor Rodionov |
 Andriy Knysh |
 Justin Burnham |
|---|