`Lambda@Edge`

Submodule which creates Lambda@Edge functions to associate with the CloudFront distribution in the parent module.

The lambda_function_association output feeds in directly to the variable of the same name in the parent module.

Important: An AWS Provider configured for us-east-1 must be passed to the module, as Lambda@Edge functions must exist in us-east-1. This is the primary reason why these resources exist in a submodule and not in the parent module.

module "lambda_at_edge" {
  source = "cloudposse/cloudfront-s3-cdn/aws//modules/lambda@edge"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  functions = {
    ...
  }

  providers = {
    aws = aws.us-east-1
  }

  context = module.this.context
}

Requirements

Name	Version
terraform	>= 0.13.0
archive	>= 2.2.0
aws	>= 3.0
time	>= 0.7.0

Providers

Name	Version
archive	>= 2.2.0
aws	>= 3.0
time	>= 0.7.0

Modules

Name	Source	Version
function_label	cloudposse/label/null	0.25.0
role	cloudposse/iam-role/aws	0.14.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_lambda_function.default	resource
aws_lambda_permission.allow_cloudfront	resource
time_sleep.lambda_at_edge_destruction_delay	resource
archive_file.lambda_zip	data source
aws_iam_policy_document.lambda_write_logs	data source

Inputs

Name	Description	Type	Default	Required
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
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
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
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
destruction_delay	The delay, in Golang ParseDuration format, to wait before destroying the Lambda@Edge functions. This delay is meant to circumvent Lambda@Edge functions not being immediately deletable following their dissociation from a CloudFront distribution, since they are replicated to CloudFront Edge servers around the world. If set to `null`, no delay will be introduced. By default, the delay is 20 minutes. This is because it takes about 3 minutes to destroy a CloudFront distribution, and around 15 minutes until the Lambda@Edge function is available for deletion, in most cases. For more information, see: https://github.com/hashicorp/terraform-provider-aws/issues/1721.	`string`	`"20m"`	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
functions	Lambda@Edge functions to create. The key of this map is the name label of the Lambda@Edge function. `source.filename` and `source.content` dictate the name and content of the files that will make up the Lambda function source, respectively. `runtime` and `handler` correspond to the attributes of the same name in the lambda_function resource. `event_type` and `include_body` correspond to the attributes of the same name in the Lambda Function association block of the cloudfront_distribution resource.	`map(object({ source = list(object({ filename = string content = string })) runtime = string handler = string event_type = string include_body = bool }))`	n/a	yes
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
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
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
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
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

Outputs

Name	Description
lambda_function_association	The Lambda@Edge function association configuration to pass to `var.lambda_function_association` in the parent module.

Lambda@Edge

Requirements​

Providers​

Modules​

Resources​

Inputs​

Outputs​