https://github.com/infrablocks/terraform-aws-lambda
Terraform module to create a lambda in a pre-existing VPC
https://github.com/infrablocks/terraform-aws-lambda
aws aws-lambda infrastructure lambda terraform terraform-modules
Last synced: 7 months ago
JSON representation
Terraform module to create a lambda in a pre-existing VPC
- Host: GitHub
- URL: https://github.com/infrablocks/terraform-aws-lambda
- Owner: infrablocks
- License: mit
- Created: 2019-07-12T13:33:19.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-04T02:15:46.000Z (9 months ago)
- Last Synced: 2025-04-05T11:34:33.109Z (9 months ago)
- Topics: aws, aws-lambda, infrastructure, lambda, terraform, terraform-modules
- Language: Ruby
- Homepage:
- Size: 597 KB
- Stars: 3
- Watchers: 8
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: security_group.tf
Awesome Lists containing this project
README
Terraform AWS Lambda
===================================
[](https://circleci.com/gh/infrablocks/terraform-aws-lambda)
A Terraform module for creating a new lambda
The lambda module requires:
* A lambda function packaged as zip
The lambda resource consists of:
- lambda function
- security group for lambda
- iam role for executing lambda
- iam policy for lambda
Usage
-----
To use the module, include something like the following in your Terraform
configuration:
```hcl-terraform
module "lambda" {
source = "infrablocks/lambda/aws"
region = "eu-west-2"
component = "my-lambda"
deployment_identifier = "development-europe"
include_vpc_access = true
vpc_id = "VPC-1234"
lambda_subnet_ids = ["subnet-id-1"]
lambda_zip_path = "lambda.zip"
lambda_ingress_cidr_blocks = ["10.10.0.0/16"]
lambda_egress_cidr_blocks = ["0.0.0.0/8"]
lambda_environment_variables = {
"TEST_ENV_VARIABLE" = "test-value"
}
lambda_function_name = "lambda-function"
lambda_handler = "handler.hello"
lambda_description = "An optional description"
tags = {
"AdditionalTags" = "my-tag"
}
lambda_execution_role_policy = jsonencode(
{
"Version" : "2012-10-17",
"Statement" : [
{
"Effect" : "Allow",
"Action" : [
"logs:DescribeLogGroups",
"logs:DescribeLogStreams",
"logs:CreateLogStream",
"logs:DeleteLogStream",
"logs:FilterLogEvents",
"logs:GetLogEvents",
"logs:PutLogEvents",
],
"Resource" : [
"arn:aws:logs:${var.region}:${data.aws_caller_identity.current.account_id}:*"
]
},
{
"Effect" : "Allow",
"Action" : [
"sns:Publish"
],
"Resource" : [
"arn:aws:sns:${var.region}:${data.aws_caller_identity.current.account_id}:*"
]
}
]
})
}
```
See the
[Terraform registry entry](https://registry.terraform.io/modules/infrablocks/lambda/aws/latest)
for more details.
### Inputs
| Name | Description | Default | Required |
|---------------------------------------|-------------------------------------------------------------------|:-------:|:--------:|
| region | AWS Region | - | yes |
| component | The component for which the load balancer is being created | - | yes |
| deployment_identifier | An identifier for this instantiation | - | yes |
| deployment_label | A unique label per deployment | - | yes |
| deployment_type | The type of deployment, e.g. development, production | - | yes |
| account_id | AWS account ID | - | yes |
| vpc_id | VPC to deploy lambda to | - | yes |
| include_vpc_access | A flag to enable VPC access | false | no |
| tags | The AWS tags to use for any deployed resources | - | no |
| lambda_subnet_ids | subnet ids for the lambda | - | yes |
| lambda_zip_path | location of your lambda zip archive | - | yes |
| lambda_ingress_cidr_blocks | ingress CIDR for lambda | - | yes |
| lambda_egress_cidr_blocks | egress CIDR for lambda | - | yes |
| lambda_function_name | lambda function name | - | yes |
| lambda_handler | handler path for lambda | - | yes |
| lambda_environment_variables | environment variables for lambda | - | yes |
| lambda_execution_role_policy | An inline policy to use for the lambda | - | no |
| lambda_description | A description to use for the lambda | - | no |
| lambda_reserved_concurrent_executions | Amount of reserved concurrent executions for this lambda function | -1 | no |
### Outputs
| Name | Description |
|-------------------------|--------------------------------------------------------------------------------------------------------------------|
| lambda_invoke_arn | The ARN to be used for invoking Lambda Function from API Gateway - to be used in aws_api_gateway_integration's uri |
| lambda_arn | The Amazon Resource Name (ARN) identifying your Lambda Function. |
| lambda_function_name | function name of the lambda |
| lambda_function_name | function name of the lambda |
| lambda_handler | The handler of the lambda |
| lambda_last_modified | The date this resource was last modified |
| lambda_id | The id of the lambda |
| lambda_memory_size | The allocated memory size of the lambda |
| lambda_runtime | The runtime environment of the lambda |
| lambda_source_code_hash | Base64-encoded representation of raw SHA-256 sum of the zip file, provided either via filename or s3_* parameters. |
| lambda_source_code_size | The size in bytes of the function .zip file. |
| lambda_version | Latest published version of your Lambda Function |
### Compatibility
This module is compatible with Terraform versions greater than or equal to
Terraform 1.1.
### VPC Access
By default, the module deploys the lambda without any access to resources in a
VPC. If `include_vpc_access` is set to `true` then the AWS lambda will be
deployed with access to the VPC identified by `vpc_id`, via the provided
`lambda_subnet_ids`.
### Execution IAM Policy
If you want to customise the execution policy for the lambda then you can
optionally supply an inline policy via the `lambda_execution_policy` variable.
Be sure to include the permissions listed in the default policy so that the
lambda can be created successfully, see `lambda_execution_policy` for the
default policy.
### Tags
The module deploys `Component`, `DeploymentType`, `DeploymentLabel` and
`DeploymentIdentifier` tags for any created infrastructure by default.
Additional tags can be optionally passed in via the `tags` input variable,
which will then be merged together with the default tags.
Development
-----------
### Machine Requirements
In order for the build to run correctly, a few tools will need to be installed
on your development machine:
* Ruby (3.1.1)
* Bundler
* git
* git-crypt
* gnupg
* direnv
* aws-vault
#### Mac OS X Setup
Installing the required tools is best managed by [homebrew](http://brew.sh).
To install homebrew:
```
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
```
Then, to install the required tools:
```
# ruby
brew install rbenv
brew install ruby-build
echo 'eval "$(rbenv init - bash)"' >> ~/.bash_profile
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc
eval "$(rbenv init -)"
rbenv install 3.1.1
rbenv rehash
rbenv local 3.1.1
gem install bundler
# git, git-crypt, gnupg
brew install git
brew install git-crypt
brew install gnupg
# aws-vault
brew cask install
# direnv
brew install direnv
echo "$(direnv hook bash)" >> ~/.bash_profile
echo "$(direnv hook zsh)" >> ~/.zshrc
eval "$(direnv hook $SHELL)"
direnv allow
```
### Running the build
Running the build requires an AWS account and AWS credentials. You are free to
configure credentials however you like as long as an access key ID and secret
access key are available. These instructions utilise
[aws-vault](https://github.com/99designs/aws-vault) which makes credential
management easy and secure.
To provision module infrastructure, run tests and then destroy that
infrastructure, execute:
```bash
aws-vault exec -- ./go
```
To provision the module prerequisites:
```bash
aws-vault exec -- ./go deployment:prerequisites:provision[]
```
To provision the module contents:
```bash
aws-vault exec -- ./go deployment:root:provision[]
```
To destroy the module contents:
```bash
aws-vault exec -- ./go deployment:root:destroy[]
```
To destroy the module prerequisites:
```bash
aws-vault exec -- ./go deployment:prerequisites:destroy[]
```
Configuration parameters can be overridden via environment variables:
```bash
DEPLOYMENT_IDENTIFIER=testing aws-vault exec -- ./go
```
When a deployment identifier is provided via an environment variable,
infrastructure will not be destroyed at the end of test execution. This can
be useful during development to avoid lengthy provision and destroy cycles.
By default, providers will be downloaded for each terraform execution. To
cache providers between calls:
```bash
TF_PLUGIN_CACHE_DIR="$HOME/.terraform.d/plugin-cache" aws-vault exec -- ./go
```
### Common Tasks
#### Generating an SSH key pair
To generate an SSH key pair:
```
ssh-keygen -m PEM -t rsa -b 4096 -C integration-test@example.com -N '' -f config/secrets/keys/bastion/ssh
```
#### Generating a self-signed certificate
To generate a self signed certificate:
```
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365
```
To decrypt the resulting key:
```
openssl rsa -in key.pem -out ssl.key
```
#### Managing CircleCI keys
To encrypt a GPG key for use by CircleCI:
```bash
openssl aes-256-cbc \
-e \
-md sha1 \
-in ./config/secrets/ci/gpg.private \
-out ./.circleci/gpg.private.enc \
-k ""
```
To check decryption is working correctly:
```bash
openssl aes-256-cbc \
-d \
-md sha1 \
-in ./.circleci/gpg.private.enc \
-k ""
```
Contributing
------------
Bug reports and pull requests are welcome on GitHub at
https://github.com/infrablocks/terraform-aws-lambda. This project is intended to
be a safe, welcoming space for collaboration, and contributors are expected to
adhere to the [Contributor Covenant](http://contributor-covenant.org) code of
conduct.
License
-------
The library is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).