Skip to main content

Component: lambda

This component is responsible for provisioning Lambda functions.


Stack Level: Regional

Stack configuration for defaults:

type: abstract
workspace_enabled: true
enabled: true

Sample App Yaml Entry:

- catalog/lambda/defaults

component: lambda
- lambda/defaults
name: hello-world-py
function_name: main
description: Hello Lambda from Python!
handler: lambda.lambda_handler # in go this is the compiled binary, python it's filename.function
memory_size: 256
runtime: python3.9
package_type: Zip # `Zip` or `Image`
policy_json: |
"Version": "2012-10-17",
"Statement": [
"Sid": "ListAllBuckets",
"Effect": "Allow",
"Action": "s3:ListAllMyBuckets",
"Resource": "*"
- sid: AllowSQSWorkerWriteAccess
effect: Allow
- sqs:SendMessage
- sqs:SendMessageBatch
- arn:aws:sqs:*:111111111111:worker-queue
# Filename example
filename: lambdas/hello-world-python/ # generated by zip variable.
enabled: true
input_dir: hello-world-python
output: hello-world-python/

# S3 Source Example
# s3_bucket_name: lambda-source # lambda calculates the rest of the bucket_name
# s3_key:


terraform>= 1.3.0
archive>= 2.3.0
aws>= 4.9.0


archive>= 2.3.0
aws>= 4.9.0




archive_file.lambdazipdata source
aws_ssm_parameter.cicd_ssm_paramdata source


additional_tag_mapAdditional 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.
architecturesInstruction 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.
attributesID 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.
cicd_s3_key_formatThe format of the S3 key to store the latest version/sha of the Lambda function. This is used with cicd_ssm_param_name. Defaults to 'stage/{stage}/lambda/{function_name}/'stringnullno
cicd_ssm_param_nameThe name of the SSM parameter to store the latest version/sha of the Lambda function. This is used with cicd_s3_key_formatstringnullno
cloudwatch_event_rulesCreates EventBridge (CloudWatch Events) rules for invoking the Lambda Function along with the required{}no
cloudwatch_lambda_insights_enabledEnable CloudWatch Lambda Insights for the Lambda Function.boolfalseno
cloudwatch_log_subscription_filtersCloudWatch Logs subscription filter resources. Currently supports only Lambda functions as{}no
cloudwatch_logs_kms_key_arnThe ARN of the KMS Key to use when encrypting log data.stringnullno
cloudwatch_logs_retention_in_daysSpecifies 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.
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
custom_iam_policy_arnsARNs of IAM policies to be attached to the Lambda roleset(string)[]no
dead_letter_config_target_arnARN 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."
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptionDescription of what the Lambda Function does.stringnullno
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
event_source_mappingsCreates event source mappings to allow the Lambda function to get events from Kinesis, DynamoDB and SQS. The IAM role
of this Lambda function will be enhanced with necessary minimum permissions to get those events.
filenameThe path to the function's deployment package within the local filesystem. If defined, The s3_-prefixed options and image_uri cannot be used.stringnullno
function_nameUnique name for the Lambda Function.stringnullno
handlerThe function entrypoint in your code.stringnullno
iam_policyIAM policy to attach to the Lambda role, specified as a Terraform object. This can be used with or instead of var.policy_json.
policy_id = optional(string, null)
version = optional(string, null)
statements = list(object({
sid = optional(string, null)
effect = optional(string, null)
actions = optional(list(string), null)
not_actions = optional(list(string), null)
resources = optional(list(string), null)
not_resources = optional(list(string), null)
conditions = optional(list(object({
test = string
variable = string
values = list(string)
})), [])
principals = optional(list(object({
type = string
identifiers = list(string)
})), [])
not_principals = optional(list(object({
type = string
identifiers = list(string)
})), [])
iam_policy_descriptionDescription of the IAM policy for the Lambda IAM rolestring"Minimum SSM read permissions for Lambda IAM Role"no
id_length_limitLimit 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.
ignore_external_function_updatesIgnore updates to the Lambda Function executed externally to the Terraform lifecycle. Set this to true if you're
using CodeDeploy, aws CLI or other external tools to update the Lambda Function code."
image_configThe 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).
image_uriThe ECR image URI containing the function's deployment package. Conflicts with filename, s3_bucket_name, s3_key, and s3_object_version.stringnullno
kms_key_arnAmazon 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.
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
lambda_at_edge_enabledEnable Lambda@Edge for your Node.js or Python functions. The required trust relationship and publishing of function versions will be configured in this module.boolfalseno
lambda_environmentEnvironment (e.g. ENV variables) configuration for the Lambda function enable you to dynamically pass settings to your function code and libraries.
variables = map(string)
layersList of Lambda Layer Version ARNs (maximum of 5) to attach to the Lambda Function.list(string)[]no
memory_sizeAmount of memory in MB the Lambda Function can use at runtime.number128no
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
package_typeThe Lambda deployment package type. Valid values are Zip and Image.string"Zip"no
permissions_boundaryARN of the policy that is used to set the permissions boundary for the rolestring""no
policy_jsonIAM policy to attach to the Lambda role, specified as JSON. This can be used with or instead of var.iam_policy.stringnullno
publishWhether to publish creation/change as new Lambda Function Version.boolfalseno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
reserved_concurrent_executionsThe amount of reserved concurrent executions for this lambda function. A value of 0 disables lambda from being triggered and -1 removes any concurrency limitations.number-1no
runtimeThe runtime environment for the Lambda function you are uploading.stringnullno
s3_bucket_nameThe name suffix of the S3 bucket 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.
s3_full_bucket_nameThe full name of the S3 bucket 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.

This is alternative to var.s3_bucket_name which formats the name for the current account.
s3_keyThe S3 key of an object containing the function's deployment package. Conflicts with filename and image_uri.stringnullno
s3_object_versionThe object version containing the function's deployment package. Conflicts with filename and image_uri.stringnullno
sns_subscriptionsCreates subscriptions to SNS topics which trigger the Lambda Function. Required Lambda invocation permissions will be{}no
source_code_hashUsed 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('') where '' is the local filename
of the lambda function source archive.
ssm_parameter_namesList 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.
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
timeoutThe amount of time the Lambda Function has to run in seconds.number3no
tracing_config_modeTracing config mode of the Lambda function. Can be either PassThrough or Active.stringnullno
vpc_configProvide 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 for details).
security_group_ids = list(string)
subnet_ids = list(string)
zipZip Configuration for local file deployments
enabled = optional(bool, false)
output = optional(string, "")
input_dir = optional(string, null)


arnARN of the lambda function
function_nameLambda function name
invoke_arnInvoke ARN of the lambda function
qualified_arnARN identifying your Lambda Function Version (if versioning is enabled via publish = true)
role_arnLambda IAM role ARN
role_nameLambda IAM role name