module-aws-cloudfront-router

A module which creates a CloudFront distribution which has an Edge Lambda attached.

Variables

Name	Description	Type	Default	Required
access_logs_bucket	If access logs are enabled the bucket the logs should go into, defaults to false.	string	""	no
acm_cert_arn	AWS ACM certificate ARN to use for the CloudFront distribution.	string	n/a	yes
aliases	Aliases used by the CloudFront distribution.	list(string)	[]	no
cached_methods	HTTP methods the CloudFront distribution will cache, defaults to GET and HEAD.	list(string)	[ "GET", "HEAD" ]	no
custom_origin_mappings	Custom origin mappings. Can be used in conjunction with S3 origin mappings Defaults to an empty map.	map(object({ origin_id = string domain_name = string path_pattern = string allowed_methods = list(string) }))	{}	no
default_cache_behavior	Default cache behaviour used by the distro, if a backend is static no query strings or cookies are forwarded.	object({ origin_id = string domain_name = string static_backend = bool allowed_methods = list(string) })	n/a	yes
default_root_object	Default root object for the CloudFront distribution, this defaults to 'index.html'.	string	"index.html"	no
default_ttl	Default TTL of objects in the cache. Set to 0 if you wish to disable caching. Defaults to 3600.	number	3600	no
domain	Domain name to use for the CloudFront distribution.	string	n/a	yes
enable_access_logs	Should accesses to the CloudFront distribution be logged, defaults to false.	bool	false	no
enable_custom_lambda	Flag to allow creation of a custom edge lambda. If set to false the following - edge lambda related variables - will be optional.	bool	true	no
geo_restriction_locations	The ISO 3166-1-alpha-2 codes for which you want CloudFront either to allow or disallow content delivery.	list(string)	[]	no
geo_restriction_type	The method that you want to use to restrict distribution of your content by country: 'none', 'whitelist', or 'blacklist'. Defaults to none.	string	"none"	no
hsts_lambda_timeout	The lambda time out applied to the hsts edge lambda, this timeout includes the time taken for the origin to respond	string	"15"	no
lambda_cf_event_type	When to trigger the Lambda: 'viewer-request', 'origin-request', 'viewer-response', 'origin-response'.	string	""	no
lambda_cf_include_body	When set to true it exposes the request body to the lambda function	bool	false	no
lambda_dist_dir	Directory of the lambda distribution which is to be published	string	""	no
lambda_handler	The lambda entry point	string	""	no
lambda_memory_size	How much memory to give the lambda	string	"128"	no
lambda_name_prefix	Name prefix to be given to the Lambda.	string	""	no
lambda_runtimme	The runtime of the lambda	string	""	no
log_cookies	If access logs are enabled, are cookies logged.	bool	false	no
max_ttl	Maximum TTL of objects in the cache. Set to 0 if you wish to disable caching. Defaults to 3600.	number	86400	no
min_ttl	Minimum TTL of objects in the cache. Defaults to 0.	number	0	no
name	The name of the distribution.	string	n/a	yes
namespace	The namespace of the distribution.	string	n/a	yes
origin_protocol_policy	Default origin_protocol_policy for the CloudFront distribution, this defaults to 'https-only'.	string	"https-only"	no
r53_zone_name	Name of the public hosted zone, this is used for creating the A record for the CloudFront distro.	string	n/a	yes
s3_origin_mappings	S3 origin mappings. Can be used in conjunction with custom origin mappings Defaults to an empty map.	map(object({ origin_id = string domain_name = string origin_access_control_id = string }))	{}	no
stage	The stage of the distribution - (dev, staging etc).	string	n/a	yes
tags	Tags applied to the distribution, these should follow what is defined here.	map(any)	n/a	yes
viewer_protocol_policy	Default viewer_protocol_policy for the CloudFront distribution, this defaults to 'redirect-to-https'.	string	"redirect-to-https"	no
wait_for_deployment	Specifies if Terrafrom should wait for deployments to complete before returning. Defaults to true.	bool	true	no
origin_read_timeout	The Custom Read timeout, in seconds. By default, AWS enforces a limit of 60.	number	30	no

custom_origin_mappings object

Name	Description
origin_id	The user defined unique id of the origin.
domain_name	The domain name of the origin.
path_pattern	The path which matches this origin.
allowed_methods	A list containing which HTTP methods CloudFront processes and forwards to the backend origin.

s3_origin_mappings object

Name	Description
origin_id	The user defined unique id of the origin.
domain_name	The domain name of the origin.
origin_access_control_id	The CloudFront origin access control id to associate with the origin.

default_cache_behavior

Name	Description
origin_id	The user defined unique id of the origin.
domain_name	The domain name of the origin.
static_backend	If true, cookies, HTTP headers and query strings will be forwarded to the origin.
allowed_methods	A list containing which HTTP methods CloudFront processes and forwards to the backend origin.

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.
lambda_role_name	IAM role name given to Edge Lambda.