Skip to main content
Sponsor @cloudposse

Module: lambda-function

This module deploys an AWS Lambda function from a Zip file or from a Docker image. Additionally, it creates an IAM role for the Lambda function, which optionally attaches policies to allow for CloudWatch Logs, Cloudwatch Insights, VPC Access and X-Ray tracing.

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 "lambda" {
  source  = "cloudposse/lambda-function/aws"
  version = "xxxx"

  filename      = "lambda.zip"
  function_name = "my-function"
  handler       = "handler.handler"
  runtime       = "nodejs14.x"
}

Examples​

Variables​

Required Variables​

function_name (string) required

Unique name for the Lambda Function.

Optional Variables​

architectures (list(string)) optional

Instruction set architecture for your Lambda function. Valid values are ["x86_64"] and ["arm64"].
Default is ["x86_64"]. Removing this attribute, function's architecture stay the same.



Default value: null

cloudwatch_lambda_insights_enabled (bool) optional

Enable CloudWatch Lambda Insights for the Lambda Function.


Default value: false

cloudwatch_logs_kms_key_arn (string) optional

The ARN of the KMS Key to use when encrypting log data.


Default value: null

cloudwatch_logs_retention_in_days (number) optional

Specifies the number of days you want to retain log events in the specified log group. Possible values are:
1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653, and 0. If you select 0, the events in the
log group are always retained and never expire.



Default value: null

custom_iam_policy_arns (set(string)) optional

ARNs of custom policies to be attached to the lambda role


Default value: [ ]

dead_letter_config_target_arn (string) optional

ARN of an SNS topic or SQS queue to notify when an invocation fails. If this option is used, the function's IAM role
must be granted suitable access to write to the target object, which means allowing either the sns:Publish or
sqs:SendMessage action on this ARN, depending on which service is targeted."



Default value: null

description (string) optional

Description of what the Lambda Function does.


Default value: null

ephemeral_storage_size (number) optional

The size of the Lambda function Ephemeral storage (/tmp) represented in MB.
The minimum supported ephemeral_storage value defaults to 512MB and the maximum supported value is 10240MB.



Default value: null

filename (string) optional

The path to the function's deployment package within the local filesystem. If defined, The s3_-prefixed options and image_uri cannot be used.


Default value: null

handler (string) optional

The function entrypoint in your code.


Default value: null

iam_policy_description (string) optional

Description of the IAM policy for the Lambda IAM role


Default value: "Provides minimum SSM read permissions."

image_config (any) optional

The Lambda OCI image configurations
block with three (optional) arguments:

  • entry_point - The ENTRYPOINT for the docker image (type list(string)).
  • command - The CMD for the docker image (type list(string)).
  • working_directory - The working directory for the docker image (type string).


Default value: { }

image_uri (string) optional

The ECR image URI containing the function's deployment package. Conflicts with filename, s3_bucket, s3_key, and s3_object_version.


Default value: null

inline_iam_policy (string) optional

Inline policy document (JSON) to attach to the lambda role


Default value: null

invoke_function_permissions optional

Defines which external source(s) can invoke this function (action 'lambda:InvokeFunction'). Attributes map to those of https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/lambda_permission. NOTE: to keep things simple, we only expose a subset of said attributes. If a more complex configuration is needed, declare the necessary lambda permissions outside of this module


Type:

list(object({
principal  = string
source_arn = string
}))

Default value: [ ]

kms_key_arn (string) optional

Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key that is used to encrypt environment variables.
If this configuration is not provided when environment variables are in use, AWS Lambda uses a default service key.
If this configuration is provided when environment variables are not in use, the AWS Lambda API does not save this
configuration and Terraform will show a perpetual difference of adding the key. To fix the perpetual difference,
remove this configuration.



Default value: ""

lambda_at_edge_enabled (bool) optional

Enable Lambda@Edge for your Node.js or Python functions. The required trust relationship and publishing of function versions will be configured in this module.


Default value: false

lambda_environment optional

Environment (e.g. env variables) configuration for the Lambda function enable you to dynamically pass settings to your function code and libraries.


Type:

object({
variables = map(string)
})

Default value: null

layers (list(string)) optional

List of Lambda Layer Version ARNs (maximum of 5) to attach to the Lambda Function.


Default value: [ ]

memory_size (number) optional

Amount of memory in MB the Lambda Function can use at runtime.


Default value: 128

package_type (string) optional

The Lambda deployment package type. Valid values are Zip and Image.


Default value: "Zip"

permissions_boundary (string) optional

ARN of the policy that is used to set the permissions boundary for the role


Default value: ""

publish (bool) optional

Whether to publish creation/change as new Lambda Function Version.


Default value: false

reserved_concurrent_executions (number) optional

The amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations.


Default value: -1

role_name (string) optional

The rolename used for the Lambda Function. If not provided, a default role name will be used.


Default value: null

runtime (string) optional

The runtime environment for the Lambda function you are uploading.


Default value: null

s3_bucket (string) optional

The S3 bucket location containing the function's deployment package. Conflicts with filename and image_uri.
This bucket must reside in the same AWS region where you are creating the Lambda function.



Default value: null

s3_key (string) optional

The S3 key of an object containing the function's deployment package. Conflicts with filename and image_uri.


Default value: null

s3_object_version (string) optional

The object version containing the function's deployment package. Conflicts with filename and image_uri.


Default value: null

source_code_hash (string) optional

Used to trigger updates. Must be set to a base64-encoded SHA256 hash of the package file specified with either
filename or s3_key. The usual way to set this is filebase64sha256('file.zip') where 'file.zip' is the local filename
of the lambda function source archive.



Default value: ""

ssm_parameter_names (list(string)) optional

List of AWS Systems Manager Parameter Store parameter names. The IAM role of this Lambda function will be enhanced
with read permissions for those parameters. Parameters must start with a forward slash and can be encrypted with the
default KMS key.



Default value: null

timeout (number) optional

The amount of time the Lambda Function has to run in seconds.


Default value: 3

tracing_config_mode (string) optional

Tracing config mode of the Lambda function. Can be either PassThrough or Active.


Default value: null

vpc_config optional

Provide this to allow your function to access your VPC (if both 'subnet_ids' and 'security_group_ids' are empty then
vpc_config is considered to be empty or unset, see https://docs.aws.amazon.com/lambda/latest/dg/vpc.html for details).



Type:

object({
security_group_ids = list(string)
subnet_ids         = list(string)
})

Default value: null

Context Variables​

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.


Required: No

Default value: { }

attributes (list(string)) optional

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.


Required: No

Default value: [ ]

context (any) optional

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.


Required: No

Default value:

{
  "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
}
delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.


Required: No

Default value: null

descriptor_formats (any) optional

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).


Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.


Required: No

Default value: null

label_key_case (string) optional

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.


Required: No

Default value: null

label_order (list(string)) optional

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.


Required: No

Default value: null

label_value_case (string) optional

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.


Required: No

Default value: null

labels_as_tags (set(string)) optional

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.


Required: No

Default value:

[
  "default"
]
name (string) optional

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.


Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.


Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.


Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs​

arn

ARN of the lambda function

cloudwatch_log_group_name

Name of Cloudwatch log group

function_name

Lambda function name

invoke_arn

Invoke ARN of the lambda function

qualified_arn

ARN identifying your Lambda Function Version (if versioning is enabled via publish = true)

role_arn

Lambda IAM role ARN

role_name

Lambda IAM role name

Dependencies​

Requirements​

  • terraform, version: >= 0.14
  • aws, version: >= 3.0

Providers​

  • aws, version: >= 3.0

Modules​

NameVersionSourceDescription
cloudwatch_log_group0.6.6cloudposse/cloudwatch-logs/awsn/a
this0.25.0cloudposse/label/nulln/a

Resources​

The following resources are used by this module:

Data Sources​

The following data sources are used by this module: