github.com/ggriffiths/terraform@v0.9.0-beta1.0.20170222213024-79c4935604cb/website/source/docs/providers/aws/r/lambda_function.html.markdown (about)

     1  ---
     2  layout: "aws"
     3  page_title: "AWS: aws_lambda_function"
     4  sidebar_current: "docs-aws-resource-lambda-function"
     5  description: |-
     6    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.
     7  ---
     8  
     9  # aws\_lambda\_function
    10  
    11  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.
    12  
    13  For information about Lambda and how to use it, see [What is AWS Lambda?][1]
    14  
    15  ## Example Usage
    16  
    17  ```
    18  resource "aws_iam_role" "iam_for_lambda" {
    19    name = "iam_for_lambda"
    20  
    21    assume_role_policy = <<EOF
    22  {
    23    "Version": "2012-10-17",
    24    "Statement": [
    25      {
    26        "Action": "sts:AssumeRole",
    27        "Principal": {
    28          "Service": "lambda.amazonaws.com"
    29        },
    30        "Effect": "Allow",
    31        "Sid": ""
    32      }
    33    ]
    34  }
    35  EOF
    36  }
    37  
    38  resource "aws_lambda_function" "test_lambda" {
    39    filename         = "lambda_function_payload.zip"
    40    function_name    = "lambda_function_name"
    41    role             = "${aws_iam_role.iam_for_lambda.arn}"
    42    handler          = "exports.test"
    43    source_code_hash = "${base64sha256(file("lambda_function_payload.zip"))}"
    44  
    45    environment {
    46      variables = {
    47        foo = "bar"
    48      }
    49    }
    50  }
    51  ```
    52  
    53  ## Argument Reference
    54  
    55  * `filename` - (Optional) A [zip file][2] containing your lambda function source code. If defined, The `s3_*` options cannot be used.
    56  * `s3_bucket` - (Optional) The S3 bucket location containing your lambda function source code. Conflicts with `filename`.
    57  * `s3_key` - (Optional) The S3 key of a [zip file][2] containing your lambda function source code. Conflicts with `filename`.
    58  * `s3_object_version` - (Optional) The object version of your lambda function source code. Conflicts with `filename`.
    59  * `function_name` - (Required) A unique name for your Lambda Function.
    60  * `handler` - (Required) The function [entrypoint][3] in your code.
    61  * `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][4] for more details.
    62  * `description` - (Optional) Description of what your Lambda Function does.
    63  * `memory_size` - (Optional) Amount of memory in MB your Lambda Function can use at runtime. Defaults to `128`. See [Limits][5]
    64  * `runtime` - (Required) See [Runtimes][6] for valid values.
    65  * `timeout` - (Optional) The amount of time your Lambda Function has to run in seconds. Defaults to `3`. See [Limits][5]
    66  * `publish` - (Optional) Whether to publish creation/change as new Lambda Function Version. Defaults to `false`.
    67  * `vpc_config` - (Optional) Provide this to allow your function to access your VPC. Fields documented below. See [Lambda in VPC][7]
    68  * `environment` - (Optional) The Lambda environment's configuration settings. Fields documented below.
    69  * `kms_key_arn` - (Optional) The ARN for the KMS encryption key.
    70  * `source_code_hash` - (Optional) Used to trigger updates. This is only useful in conjunction with `filename`.
    71    The only useful value is `${base64sha256(file("file.zip"))}`.
    72  
    73  **vpc\_config** requires the following:
    74  
    75  * `subnet_ids` - (Required) A list of subnet IDs associated with the Lambda function.
    76  * `security_group_ids` - (Required) A list of security group IDs associated with the Lambda function.
    77  
    78  ~> **NOTE:** if both `subnet_ids` and `security_group_ids` are empty then vpc_config is considered to be empty or unset.
    79  
    80  For **environment** the following attributes are supported:
    81  
    82  * `variables` - (Optional) A map that defines environment variables for the Lambda function.
    83  
    84  ## Attributes Reference
    85  
    86  * `arn` - The Amazon Resource Name (ARN) identifying your Lambda Function.
    87  * `qualified_arn` - The Amazon Resource Name (ARN) identifying your Lambda Function Version
    88    (if versioning is enabled via `publish = true`).
    89  * `version` - Latest published version of your Lambda Function.
    90  * `last_modified` - The date this resource was last modified.
    91  * `kms_key_arn` - (Optional) The ARN for the KMS encryption key.
    92  * `source_code_hash` - Base64-encoded representation of raw SHA-256 sum of the zip file
    93    provided either via `filename` or `s3_*` parameters.
    94  
    95  [1]: https://docs.aws.amazon.com/lambda/latest/dg/welcome.html
    96  [2]: https://docs.aws.amazon.com/lambda/latest/dg/walkthrough-s3-events-adminuser-create-test-function-create-function.html
    97  [3]: https://docs.aws.amazon.com/lambda/latest/dg/walkthrough-custom-events-create-test-function.html
    98  [4]: https://docs.aws.amazon.com/lambda/latest/dg/intro-permission-model.html
    99  [5]: https://docs.aws.amazon.com/lambda/latest/dg/limits.html
   100  [6]: https://docs.aws.amazon.com/lambda/latest/dg/API_CreateFunction.html#SSS-CreateFunction-request-Runtime
   101  [7]: http://docs.aws.amazon.com/lambda/latest/dg/vpc.html
   102  
   103  ## Import
   104  
   105  Lambda Functions can be imported using the `function_name`, e.g.
   106  
   107  ```
   108  $ terraform import aws_lambda_function.tesr_lambda my_test_lambda_function
   109  ```