7.2 KiB

Raw Blame History

layout	page_title	sidebar_current	description
aws	AWS: aws_lambda_function	docs-aws-resource-lambda-function	Provides a Lambda Function resource. Lambda allows you to trigger execution of code in response to events in AWS. The Lambda Function itself includes source code and runtime configuration.

aws_lambda_function

Provides a Lambda Function resource. Lambda allows you to trigger execution of code in response to events in AWS. The Lambda Function itself includes source code and runtime configuration.

For information about Lambda and how to use it, see What is AWS Lambda?

Example Usage

resource "aws_iam_role" "iam_for_lambda" {
  name = "iam_for_lambda"

  assume_role_policy = <<EOF
{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": "sts:AssumeRole",
      "Principal": {
        "Service": "lambda.amazonaws.com"
      },
      "Effect": "Allow",
      "Sid": ""
    }
  ]
}
EOF
}

resource "aws_lambda_function" "test_lambda" {
  filename         = "lambda_function_payload.zip"
  function_name    = "lambda_function_name"
  role             = "${aws_iam_role.iam_for_lambda.arn}"
  handler          = "exports.test"
  source_code_hash = "${base64sha256(file("lambda_function_payload.zip"))}"
  runtime          = "nodejs4.3"

  environment {
    variables = {
      foo = "bar"
    }
  }
}

Specifying the Deployment Package

AWS Lambda expects source code to be provided as a deployment package whose structure varies depending on which runtime is in use. See Runtimes for the valid values of runtime. The expected structure of the deployment package can be found in the AWS Lambda documentation for each runtime.

Once you have created your deployment package you can specify it either directly as a local file (using the filename argument) or indirectly via Amazon S3 (using the s3_bucket, s3_key and s3_object_version arguments). When providing the deployment package via S3 it may be useful to use the aws_s3_bucket_object resource to upload it.

For larger deployment packages it is recommended by Amazon to upload via S3, since the S3 API has better support for uploading large files efficiently.

Argument Reference

filename - (Optional) The path to the function's deployment package within the local filesystem. If defined, The s3_-prefixed options cannot be used.
s3_bucket - (Optional) The S3 bucket location containing the function's deployment package. Conflicts with filename.
s3_key - (Optional) The S3 key of an object containing the function's deployment package. Conflicts with filename.
s3_object_version - (Optional) The object version containing the function's deployment package. Conflicts with filename.
function_name - (Required) A unique name for your Lambda Function.
dead_letter_config - (Optional) Nested block to configure the function's dead letter queue. See details below.
handler - (Required) The function entrypoint in your code.
role - (Required) IAM role 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.
description - (Optional) Description of what your Lambda Function does.
memory_size - (Optional) Amount of memory in MB your Lambda Function can use at runtime. Defaults to 128. See Limits
runtime - (Required) See Runtimes for valid values.
timeout - (Optional) The amount of time your Lambda Function has to run in seconds. Defaults to 3. See Limits
publish - (Optional) Whether to publish creation/change as new Lambda Function Version. Defaults to false.
vpc_config - (Optional) Provide this to allow your function to access your VPC. Fields documented below. See Lambda in VPC
environment - (Optional) The Lambda environment's configuration settings. Fields documented below.
kms_key_arn - (Optional) The ARN for the KMS encryption key.
source_code_hash - (Optional) 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 ${base64sha256(file("file.zip"))}, where "file.zip" is the local filename of the lambda function source archive.
tags - (Optional) A mapping of tags to assign to the object.

dead_letter_config is a child block with a single argument:

target_arn - (Required) The 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.

tracing_config is a child block with a single argument:

mode - (Required) Can be either PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If Active, Lambda will respect any tracing header it receives from an upstream service. If no tracing header is received, Lambda will call X-Ray for a tracing decision.

vpc_config requires the following:

subnet_ids - (Required) A list of subnet IDs associated with the Lambda function.
security_group_ids - (Required) A list of security group IDs associated with the Lambda function.

~> NOTE: if both subnet_ids and security_group_ids are empty then vpc_config is considered to be empty or unset.

For environment the following attributes are supported:

variables - (Optional) A map that defines environment variables for the Lambda function.

Attributes Reference

arn - The Amazon Resource Name (ARN) identifying your Lambda Function.
qualified_arn - The Amazon Resource Name (ARN) identifying your Lambda Function Version (if versioning is enabled via publish = true).
invoke_arn - The ARN to be used for invoking Lambda Function from API Gateway - to be used in aws_api_gateway_integration's uri
version - Latest published version of your Lambda Function.
last_modified - The date this resource was last modified.
kms_key_arn - (Optional) The ARN for the KMS encryption key.
source_code_hash - Base64-encoded representation of raw SHA-256 sum of the zip file provided either via filename or s3_* parameters.

Import

Lambda Functions can be imported using the function_name, e.g.

$ terraform import aws_lambda_function.test_lambda my_test_lambda_function

7.2 KiB Raw Blame History