Module: `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.

Usage

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

Requirements

Name	Version
terraform	>= 1.0
aws	>= 4.9.0
local	>= 1.2

Providers

Name	Version
aws	>= 4.9.0

Modules

Name	Source	Version
dns	cloudposse/route53-alias/aws	0.13.0
logs	cloudposse/s3-log-storage/aws	1.4.2
origin_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudfront_distribution.default	resource
aws_cloudfront_origin_access_identity.default	resource

Inputs

Name	Description	Type	Default	Required
acm_certificate_arn	Existing ACM Certificate ARN	`string`	`""`	no
additional_tag_map	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.	`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	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.	`list(string)`	`[]`	no
cache_policy_id	ID of the cache policy attached to the cache behavior	`string`	`null`	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.	`any`	`{ "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 }`	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
custom_origins	One or more custom origins for this distribution (multiples allowed). See documentation for configuration options description https://www.terraform.io/docs/providers/aws/r/cloudfront_distribution.html#origin-arguments	`list(object({ domain_name = string origin_id = string origin_path = string custom_headers = list(object({ name = string value = string })) custom_origin_config = object({ http_port = number https_port = number origin_protocol_policy = string origin_ssl_protocols = list(string) origin_keepalive_timeout = number origin_read_timeout = number }) s3_origin_config = object({ origin_access_identity = 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 ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
descriptor_formats	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).	`any`	`{}`	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	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role '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
function_association	A config block that triggers a CloudFront function with specific actions. See the aws_cloudfront_distribution documentation for more information.	`list(object({ event_type = string function_arn = string }))`	`[]`	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
http_version	The maximum HTTP version to support on the distribution. Allowed values are http1.1, http2, http2and3 and http3.	`string`	`"http2"`	no
id_length_limit	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`.	`number`	`null`	no
is_ipv6_enabled	State of CloudFront IPv6	`bool`	`true`	no
label_key_case	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`.	`string`	`null`	no
label_order	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.	`list(string)`	`null`	no
label_value_case	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`.	`string`	`null`	no
labels_as_tags	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.	`set(string)`	`[ "default" ]`	no
lambda_function_association	A config block that triggers a Lambda@Edge function with specific actions	`list(object({ event_type = string include_body = bool lambda_arn = string }))`	`[]`	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_force_destroy	Applies to log bucket created by this module only. If true, all objects will be deleted from the bucket on destroy, so that the bucket can be destroyed without error. These objects are not recoverable.	`bool`	`false`	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	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.	`string`	`null`	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	`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) cache_policy_id = string origin_request_policy_id = 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 response_headers_policy_id = string lambda_function_association = list(object({ event_type = string include_body = bool lambda_arn = string })) function_association = list(object({ event_type = string function_arn = string })) }))	`[]`	no
origin_access_identity_enabled	When true, creates origin access identity resource	`bool`	`true`	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_request_policy_id	ID of the origin request policy attached to the cache behavior	`string`	`null`	no
origin_shield	The CloudFront Origin Shield settings	`object({ enabled = bool region = string })`	`null`	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
realtime_log_config_arn	The ARN of the real-time log configuration that is attached to this cache behavior	`string`	`null`	no
regex_replace_chars	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.	`string`	`null`	no
response_headers_policy_id	The identifier for a response headers policy	`string`	`""`	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	`string`	`null`	no
tags	Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). Neither the tag keys nor the tag values will be modified by this module.	`map(string)`	`{}`	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	`string`	`null`	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. This is ignored if the default CloudFront certificate is used.	`string`	`"TLSv1.2_2021"`	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

Module: cloudfront-cdn

Usage​

Generating ACM Certificate​

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​