GitHub - cloudposse-terraform-components/aws-lambda: This component is responsible for provisioning Lambda functions

This component is responsible for provisioning Lambda functions.

Usage

Stack Level: Regional

Stack configuration for defaults:

components:
  terraform:
    lambda-defaults:
      metadata:
        type: abstract
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true

Sample App Yaml Entry:

import:
  - catalog/lambda/defaults

components:
  terraform:
    lambda/hello-world-py:
      metadata:
        component: lambda
        inherits:
          - lambda/defaults
      vars:
        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
        # https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html
        runtime: python3.9
        package_type: Zip # `Zip` or `Image`
        policy_json: |
          {
            "Version": "2012-10-17",
            "Statement": [
              {
                "Sid": "ListAllBuckets",
                "Effect": "Allow",
                "Action": "s3:ListAllMyBuckets",
                "Resource": "*"
              }
            ]
          }
        iam_policy:
          statements:
            - sid: AllowSQSWorkerWriteAccess
              effect: Allow
              actions:
                - sqs:SendMessage
                - sqs:SendMessageBatch
              resources:
                - arn:aws:sqs:*:111111111111:worker-queue
        # Filename example
        filename: lambdas/hello-world-python/output.zip # generated by zip variable.
        zip:
          enabled: true
          input_dir: hello-world-python
          output: hello-world-python/output.zip

        # S3 Source Example
        # s3_bucket_name: lambda-source # lambda main.tf calculates the rest of the bucket_name
        # s3_key: hello-world-go.zip

Notifications:

SQS

sqs_notifications:
  my-service-a:
    sqs_component:
      component: sqs-queue/my-service-a
  my-service-b:
    sqs_arn: arn:aws:sqs:us-west-2:111111111111:my-service-b

S3

s3_notifications:
  my-service-a:
    bucket_component:
      component: s3-bucket/my-service-a
    events: ["s3:ObjectCreated:*"]
  my-service-b:
    bucket_name: my-service-b
    events: ["s3:ObjectCreated:*", "s3:ObjectRemoved:*"]

Cron (CloudWatch Event)

cloudwatch_event_rules:
  schedule-a:
    schedule_expression: "rate(5 minutes)"
  schedule-b:
    schedule_expression: "cron(0 20 * * ? *)"

Requirements

Name	Version
terraform	>= 1.3.0
archive	>= 2.3.0
aws	>= 4.9.0
random	>= 3.0.0

Providers

Name	Version
archive	>= 2.3.0
aws	>= 4.9.0
random	>= 3.0.0

Modules

Name	Source	Version
cloudwatch_event_rules_label	cloudposse/label/null	0.25.0
iam_policy	cloudposse/iam-policy/aws	1.0.1
iam_roles	../account-map/modules/iam-roles	n/a
lambda	cloudposse/lambda-function/aws	0.6.1
s3_bucket	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
s3_bucket_notifications_component	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
sqs_iam_policy	cloudposse/iam-policy/aws	1.0.1
sqs_queue	cloudposse/stack-config/yaml//modules/remote-state	1.5.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_event_rule.event_rules	resource
aws_cloudwatch_event_target.sns	resource
aws_iam_role_policy_attachment.default	resource
aws_iam_role_policy_attachment.sqs_default	resource
aws_lambda_event_source_mapping.event_source_mapping	resource
aws_lambda_function_url.lambda_url	resource
aws_lambda_permission.allow_cloudwatch_to_call_lambda	resource
aws_lambda_permission.s3_notification	resource
aws_s3_bucket_notification.s3_notifications	resource
random_pet.zip_recreator	resource
archive_file.lambdazip	data source
aws_ssm_parameter.cicd_ssm_param	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
architectures	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.	`list(string)`	`null`	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
cicd_s3_key_format	The 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}/%s.zip'	`string`	`null`	no
cicd_ssm_param_name	The name of the SSM parameter to store the latest version/sha of the Lambda function. This is used with cicd_s3_key_format	`string`	`null`	no
cloudwatch_event_rules	Creates EventBridge (CloudWatch Events) rules for invoking the Lambda Function along with the required permissions.	map(object({ description = optional(string) event_bus_name = optional(string) event_pattern = optional(string) is_enabled = optional(bool) name_prefix = optional(string) role_arn = optional(string) schedule_expression = optional(string) }))	`{}`	no
cloudwatch_lambda_insights_enabled	Enable CloudWatch Lambda Insights for the Lambda Function.	`bool`	`false`	no
cloudwatch_logs_kms_key_arn	The ARN of the KMS Key to use when encrypting log data.	`string`	`null`	no
cloudwatch_logs_retention_in_days	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.	`number`	`null`	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_iam_policy_arns	ARNs of IAM policies to be attached to the Lambda role	`set(string)`	`[]`	no
dead_letter_config_target_arn	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."	`string`	`null`	no
delimiter	Delimiter to be used between ID elements. Defaults to `-` (hyphen). Set to `""` to use no delimiter at all.	`string`	`null`	no
description	Description of what the Lambda Function does.	`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
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
filename	The path to the function's deployment package within the local filesystem. Works well with the `zip` variable. If defined, The s3_-prefixed options and image_uri cannot be used.	`string`	`null`	no
function_name	Unique name for the Lambda Function.	`string`	`null`	no
function_url_enabled	Create a aws_lambda_function_url resource to expose the Lambda function	`bool`	`false`	no
handler	The function entrypoint in your code.	`string`	`null`	no
iam_policy	IAM policy to attach to the Lambda role, specified as a Terraform object. This can be used with or instead of `var.policy_json`.	object({ 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) })), []) })) })	`null`	no
iam_policy_description	Description of the IAM policy for the Lambda IAM role	`string`	`"Minimum SSM read permissions for Lambda IAM Role"`	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
image_config	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`).	`any`	`{}`	no
image_uri	The ECR image URI containing the function's deployment package. Conflicts with `filename`, `s3_bucket_name`, `s3_key`, and `s3_object_version`.	`string`	`null`	no
kms_key_arn	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.	`string`	`""`	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_at_edge_enabled	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.	`bool`	`false`	no
lambda_environment	Environment (e.g. ENV variables) configuration for the Lambda function enable you to dynamically pass settings to your function code and libraries.	object({ variables = map(string) })	`null`	no
layers	List of Lambda Layer Version ARNs (maximum of 5) to attach to the Lambda Function.	`list(string)`	`[]`	no
memory_size	Amount of memory in MB the Lambda Function can use at runtime.	`number`	`128`	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
package_type	The Lambda deployment package type. Valid values are `Zip` and `Image`.	`string`	`"Zip"`	no
permissions_boundary	ARN of the policy that is used to set the permissions boundary for the role	`string`	`""`	no
policy_json	IAM policy to attach to the Lambda role, specified as JSON. This can be used with or instead of `var.iam_policy`.	`string`	`null`	no
publish	Whether to publish creation/change as new Lambda Function Version.	`bool`	`false`	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
region	AWS Region	`string`	n/a	yes
reserved_concurrent_executions	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.	`number`	`-1`	no
runtime	The runtime environment for the Lambda function you are uploading.	`string`	`null`	no
s3_bucket_component	The bucket component to use for the S3 bucket containing the function's deployment package. Conflicts with `s3_bucket_name`, `filename` and `image_uri`.	object({ component = string tenant = optional(string) stage = optional(string) environment = optional(string) })	`null`	no
s3_bucket_name	The 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.	`string`	`null`	no
s3_key	The S3 key of an object containing the function's deployment package. Conflicts with filename and image_uri.	`string`	`null`	no
s3_notifications	A map of S3 bucket notifications to trigger the Lambda function	map(object({ bucket_name = optional(string) bucket_component = optional(object({ component = string environment = optional(string) tenant = optional(string) stage = optional(string) })) events = optional(list(string)) filter_prefix = optional(string) filter_suffix = optional(string) source_account = optional(string) }))	`{}`	no
s3_object_version	The object version containing the function's deployment package. Conflicts with filename and image_uri.	`string`	`null`	no
source_code_hash	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.	`string`	`""`	no
sqs_notifications	A map of SQS queue notifications to trigger the Lambda function	map(object({ sqs_arn = optional(string) sqs_component = optional(object({ component = string environment = optional(string) tenant = optional(string) stage = optional(string) })) batch_size = optional(number) source_account = optional(string) on_failure_arn = optional(string) maximum_concurrency = optional(number) }))	`{}`	no
ssm_parameter_names	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.	`list(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
timeout	The amount of time the Lambda Function has to run in seconds.	`number`	`3`	no
tracing_config_mode	Tracing config mode of the Lambda function. Can be either PassThrough or Active.	`string`	`null`	no
vpc_config	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).	object({ security_group_ids = list(string) subnet_ids = list(string) })	`null`	no
zip	Zip Configuration for local file deployments	object({ enabled = optional(bool, false) output = optional(string, "output.zip") input_dir = optional(string, null) })	{ "enabled": false, "output": "output.zip" }	no

Outputs

Name	Description
arn	ARN of the lambda function
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

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Note

This project is part of Cloud Posse's comprehensive "SweetOps" approach towards DevOps.

Learn More

It's 100% Open Source and licensed under the APACHE2.

Related Projects

Check out these related projects.

Cloud Posse Terraform Modules - Our collection of reusable Terraform modules used by our reference architectures.
Atmos - Atmos is like docker-compose but for your infrastructure

✨ Contributing

This project is under active development, and we encourage contributions from our community. Many thanks to our outstanding contributors:

🐛 Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

💻 Developing

If you are interested in being a contributor and want to get involved in developing this project or help out with Cloud Posse's other projects, we would love to hear from you! Hit us up in Slack, in the #cloudposse channel.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

About

This project is maintained by Cloud Posse, LLC.

We are a DevOps Accelerator for funded startups and enterprises. Use our ready-to-go terraform architecture blueprints for AWS to get up and running quickly. We build it with you. You own everything. Your team wins. Plus, we stick around until you succeed.

Your team can operate like a pro today.

Ensure that your team succeeds by using our proven process and turnkey blueprints. Plus, we stick around until you succeed.

📚 See What's Included

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. You'll have a battle-tested deployment strategy using GitHub Actions that's automated and repeatable.
Site Reliability Engineering. You'll have total visibility into your apps and microservices.
Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
GitOps. You'll be able to operate your infrastructure via Pull Requests.
Training. You'll receive hands-on training so your team can operate what we build.
Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
Troubleshooting. You'll get help to triage when things aren't working.
Code Reviews. You'll receive constructive feedback on Pull Requests.
Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

License

Preamble to the Apache License, Version 2.0

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Name		Name	Last commit message	Last commit date
Latest commit History 14 Commits
.github		.github
docs		docs
src		src
test		test
.gitattributes		.gitattributes
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
.tflint.hcl		.tflint.hcl
Makefile		Makefile
README.md		README.md
README.yaml		README.yaml
_typos.toml		_typos.toml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Usage

Notifications:

SQS

S3

Cron (CloudWatch Event)

Requirements

Providers

Modules

Resources

Inputs

Outputs

References

Related Projects

✨ Contributing

🐛 Bug Reports & Feature Requests

💻 Developing

🌎 Slack Community

📰 Newsletter

📆 Office Hours

About

License

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

Releases 1

Packages

Contributors 12

Languages

cloudposse-terraform-components/aws-lambda

Folders and files

Latest commit

History

Repository files navigation

Usage

Notifications:

SQS

S3

Cron (CloudWatch Event)

Requirements

Providers

Modules

Resources

Inputs

Outputs

References

Related Projects

✨ Contributing

🐛 Bug Reports & Feature Requests

💻 Developing

🌎 Slack Community

📰 Newsletter

📆 Office Hours

About

License

Trademarks

All other trademarks referenced herein are the property of their respective owners.

About

Topics

Resources

Stars

Watchers

Forks

Releases 1

Packages 0

Contributors 12

Languages

Packages