Awesome

Modernisation Platform Lambda Function Terraform Module

Usage


module "lambda" {
  source                         = "github.com/ministryofjustice/modernisation-platform-terraform-lambda-function"
  application_name               = local.application_name
  tags                           = local.tags
  description                    = "lambda description"
  role_name                      = local.lambda_role_name
  policy_json                    = data.aws_iam_policy_document.lambda_policy.json
  function_name                  = local.lambda_function_name
  create_role                    = true
  reserved_concurrent_executions = 1
  environment_variables = {
    "key1" = "value1"
  }
  image_uri    = local.ecr_image_uri
  timeout      = 600
  tracing_mode = "Active"

  allowed_triggers = {
    AllowStopExecutionFromCloudWatch = {
      principal  = "events.amazonaws.com"
      source_arn = aws_cloudwatch_event_rule.lambda_cloudwatch_schedule_morning.arn
    }
    AllowStartExecutionFromCloudWatch = {
      principal  = "events.amazonaws.com"
      source_arn = aws_cloudwatch_event_rule.lambda_cloudwatch_schedule_evening.arn
    }
  }

}

Looking for issues?

If you're looking to raise an issue with this module, please create a new issue in the Modernisation Platform repository.

Requirements

Name	Version
<a name="requirement_terraform"></a> terraform	>= 1.0.1
<a name="requirement_aws"></a> aws	~> 5.0

Providers

Name	Version
<a name="provider_aws"></a> aws	~> 5.0

Modules

No modules.

Resources

Name	Type
aws_iam_policy.policy_from_json	resource
aws_iam_role.this	resource
aws_iam_role_policy_attachment.policy_arns	resource
aws_iam_role_policy_attachment.policy_from_json	resource
aws_lambda_function.this	resource
aws_lambda_function_event_invoke_config.this	resource
aws_lambda_permission.allowed_triggers	resource
aws_iam_policy_document.assume_role	data source
aws_iam_policy_document.combined-assume-role-policy	data source

Inputs

Name	Description	Type	Default	Required
<a name="input_additional_trust_roles"></a> additional_trust_roles	ARN of other roles to be passed as principals for sts:AssumeRole	`list(string)`	`[]`	no
<a name="input_additional_trust_statements"></a> additional_trust_statements	Json attributes of additional iam policy documents to add to the trust policy	`list(string)`	`[]`	no
<a name="input_allowed_triggers"></a> allowed_triggers	Map of allowed triggers to create Lambda permissions	`map(any)`	`{}`	no
<a name="input_application_name"></a> application_name	Name of application	`string`	n/a	yes
<a name="input_create_role"></a> create_role	Controls whether IAM role for Lambda Function should be created	`bool`	`true`	no
<a name="input_description"></a> description	Description of your Lambda Function (or Layer)	`string`	`""`	no
<a name="input_environment_variables"></a> environment_variables	A map that defines environment variables for the Lambda Function.	`map(string)`	`{}`	no
<a name="input_filename"></a> filename	The absolute path to an existing zip-file to use	`string`	`null`	no
<a name="input_function_name"></a> function_name	A unique name for your Lambda Function	`string`	`""`	no
<a name="input_handler"></a> handler	Lambda Function entrypoint in your code	`string`	`null`	no
<a name="input_image_uri"></a> image_uri	The ECR image URI containing the function's deployment package.	`string`	`null`	no
<a name="input_lambda_role"></a> lambda_role	IAM role ARN attached to the Lambda Function. This governs both who / what can invoke your Lambda Function, as well as what resources our Lambda Function has access to. See Lambda Permission Model for more details.	`string`	`""`	no
<a name="input_memory_size"></a> memory_size	Amount of memory in MB your Lambda Function can use at runtime	`number`	`128`	no
<a name="input_package_type"></a> package_type	The Lambda deployment package type. Valid options: Image or Zip	`string`	`"Image"`	no
<a name="input_policy_arns"></a> policy_arns	List of policy statements ARN to attach to Lambda Function role	`list(string)`	`[]`	no
<a name="input_policy_json"></a> policy_json	An policy document as JSON to attach to the Lambda Function role	`string`	`null`	no
<a name="input_policy_json_attached"></a> policy_json_attached	A json policy document is being passed into the module	`bool`	`false`	no
<a name="input_policy_name"></a> policy_name	IAM policy name. It override the default value, which is the same as role_name	`string`	`null`	no
<a name="input_reserved_concurrent_executions"></a> reserved_concurrent_executions	The amount of reserved concurrent executions for this Lambda Function. A value of 0 disables Lambda Function from being triggered and -1 removes any concurrency limitations. Defaults to Unreserved Concurrency Limits -1.	`number`	`-1`	no
<a name="input_role_description"></a> role_description	Description of IAM role to use for Lambda Function	`string`	`null`	no
<a name="input_role_name"></a> role_name	Name of IAM role to use for Lambda Function	`string`	`null`	no
<a name="input_runtime"></a> runtime	Lambda function runtime	`string`	`null`	no
<a name="input_sns_topic_on_failure"></a> sns_topic_on_failure	SNS topic arn for the lambda's destination on failure.	`string`	`""`	no
<a name="input_sns_topic_on_success"></a> sns_topic_on_success	SNS topic arn for the lambda's destination on success.	`string`	`""`	no
<a name="input_source_code_hash"></a> source_code_hash	Hash value of the archive file. Calculated externally. Use to trigger updates when source file is changed.	`string`	`null`	no
<a name="input_tags"></a> tags	Common tags to be used by all resources	`map(string)`	n/a	yes
<a name="input_timeout"></a> timeout	The amount of time your Lambda Function has to run in seconds.	`number`	`3`	no
<a name="input_tracing_mode"></a> tracing_mode	Tracing mode of the Lambda Function. Valid value can be either PassThrough or Active.	`string`	`null`	no
<a name="input_vpc_security_group_ids"></a> vpc_security_group_ids	List of security group ids when Lambda Function should run in the VPC.	`list(string)`	`null`	no
<a name="input_vpc_subnet_ids"></a> vpc_subnet_ids	List of subnet ids when Lambda Function should run in the VPC. Usually private or intra subnets.	`list(string)`	`null`	no

Outputs

Name	Description
<a name="output_lambda_function_arn"></a> lambda_function_arn	The ARN of the Lambda Function
<a name="output_lambda_function_invoke_arn"></a> lambda_function_invoke_arn	The invoke ARN of the Lambda Function
<a name="output_lambda_function_name"></a> lambda_function_name	The Name of the Lambda Function
<a name="output_vpc_security_group_ids"></a> vpc_security_group_ids	The VPC security groups the lambda function has been deployed into
<a name="output_vpc_subnet_ids"></a> vpc_subnet_ids	The vpc subnet(s) the Lambda function has been deployed into