README.yaml

# Name of this project
name: terraform-aws-lambda-function

# License of this project
license: "APACHE2"

# Copyrights
copyrights:
  - name: "Cloud Posse, LLC"
    url: "https://cloudposse.com"
    year: "2022"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-lambda-function

badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-lambda-function.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-lambda-function/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-lambda-function.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-lambda-function/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com
references:
  - name: "Cloud Posse Documentation"
    url: "https://docs.cloudposse.com"
    description: "The Cloud Posse Developer Hub (documentation)"
  - name: "Terraform Standard Module Structure"
    description: "HashiCorp's standard module structure is a file and directory layout we recommend for reusable modules distributed in separate repositories."
    url: "https://www.terraform.io/docs/language/modules/develop/structure.html"
  - name: "Terraform Module Requirements"
    description: "HashiCorp's guidance on all the requirements for publishing a module. Meeting the requirements for publishing a module is extremely easy."
    url: "https://www.terraform.io/docs/registry/modules/publish.html#requirements"
  - name: "Terraform Version Pinning"
    description: "The required_version setting can be used to constrain which versions of the Terraform CLI can be used with your configuration"
    url: "https://www.terraform.io/docs/language/settings/index.html#specifying-a-required-terraform-version"


# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-null-label"
    description: "Terraform module designed to generate consistent names and tags for resources. Use terraform-null-label to implement a strict naming convention."
    url: "https://github.com/cloudposse/terraform-null-label"

description: |-
  This module deploys an AWS Lambda function from a Zip file or from a Docker image. Additionally, it creates an IAM 
  role for the Lambda function, which optionally attaches policies to allow for CloudWatch Logs, Cloudwatch Insights, 
  VPC Access and X-Ray tracing.

# How to use this module. Should be an easy example to copy and paste.
usage: |-
  For a complete example, see [examples/complete](examples/complete).
  For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest)
  (which tests and deploys the example on AWS), see [test](test).

  ```hcl
  module "lambda" {
    source  = "cloudposse/lambda-function/aws"
    version = "xxxx"

    filename      = "lambda.zip"
    function_name = "my-function"
    handler       = "handler.handler"
    runtime       = "nodejs14.x"
  }
  ```

examples: |-
  - [`examples/complete`](https://github.com/cloudposse/terraform-aws-lambda-function/blob/main/examples/complete) - complete example of using this module
  - [`examples/docker-image`](https://github.com/cloudposse/terraform-aws-lambda-function/blob/main/examples/docker-image) - example of using Lambda with Docker images

# Other files to include in this README from the project folder
include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []