Module: Function

This module provides a Lambda function which logs to CloudWatch. If no image URI is provided it will also create an ECR repository for one to upload.

Contents

• Requirements
• Inputs
• Outputs
• Example
• Contributing

Requirements

Name	Version
terraform	>= 1.0
aws	>= 5.20

Inputs

Name	Description	Type	Default	Required
identifier	Unique identifier to differentiate global resources.	string	n/a	yes
policies	List of IAM policy ARNs for the Lambda's IAM role.	list(string)	[]	no
vpc_config	Object to define the subnets and security groups for the Lambda function.	object	null	no
log_config	Object to define logging configuration of the Lambda function to CloudWatch.	object	null	no
image	Object of the image which will be pulled by the Lambda function to execute.	object	null	no
memory_size	Amount of memory in MB the Lambda function can use at runtime.	number	128	no
timeout	Amount of time the Lambda function has to run in seconds.	number	3	no
env_variables	A map of environment variables for the Lambda function at runtime.	map(string)	{}	no
tags	A map of tags to add to all resources.	map(string)	{}	no

vpc_config

Name	Description	Type	Default	Required
subnets	List of subnet IDs in which the Lambda function will run in.	list(string)	n/a	yes
security_groups	List of security group IDs the Lambda function will hold.	list(string)	n/a	yes

log_config

Name	Description	Type	Default	Required
retention_in_days	Specifies the number of days the log events shall be retained. Valid values: 1, 3, 5, 7, 14, 30, 365 and 0 (never expire).	number	n/a	yes

image

Name	Description	Type	Default	Required
uri	URI to the image.	string	n/a	yes

Outputs

Name	Description
arn	The ARN of the Lambda function.
invoke_arn	The invoke ARN of the Lambda function.
log_group_name	The name of the CloudWatch log group created for the Lambda function to log to.
log_group_arn	The ARN of the CloudWatch log group created for the Lambda function to log to.

Example

module "function" {
  source = "github.com/custom-terraform-aws-modules/function"

  identifier  = "example-function-dev"
  memory_size = 128
  timeout     = 3
  policies = [
    "arn:aws:iam::aws:policy/aws-service-role/AccessAnalyzerServiceRolePolicy",
    "arn:aws:iam::aws:policy/AdministratorAccess-Amplify"
  ]

  log_config = {
    retention_in_days = 7
  }

  image = {
    uri = "test.registry:latest"
  }

  env_variables = {
    TEST_VAR = 3
  }

  vpc_config = {
    subnets         = ["subnet-938y92g2", "subnet-a98yewgwe"]
    security_groups = ["sg-woht9328g23", "sg-3429yfwlefhwe"]
  }

  tags = {
    Project     = "example-project"
    Environment = "dev"
  }
}

Contributing

In order for a seamless CI workflow copy the pre-commit git hook from .github/hooks into your local .git/hooks. The hook formats the terraform code automatically before each commit.

cp ./.github/hooks/pre-commit ./.git/hooks/pre-commit