README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-datadog-lambda-forwarder

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

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

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

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-datadog-lambda-forwarder.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-datadog-lambda-forwarder/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-datadog-lambda-forwarder.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-datadog-lambda-forwarder/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# 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"

# List any resources helpful for someone to get started. For example, link to the hashicorp documentation or AWS documentation.
references:
  - 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/modules/index.html#standard-module-structure"
  - 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 `random_integer` Resource"
    description: "The resource random_integer generates random values from a given range, described by the min and max attributes of a given resource."
    url: "https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/integer"
  - 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/configuration/terraform.html#specifying-a-required-terraform-version"

# Short description of this project
description: |-
  Terraform module to provision all the necessary infrastructure to deploy [Datadog Lambda forwarders](https://github.com/DataDog/datadog-serverless-functions/tree/master/aws/logs_monitoring)

# Introduction to the project
#introduction: |-
#  This is an introduction.

# 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).

  To enable Datadog forwarder for RDS Enhanced monitoring:
  ```hcl
  module "datadog_lambda_forwarder" {
    source = "cloudposse/datadog-lambda-forwarder/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    forwarder_rds_enabled = true
  }
  ```

  To enable Datadog forwarder for a CloudTrail S3 bucket:
  ```hcl
  module "datadog_lambda_forwarder" {
    source = "cloudposse/datadog-lambda-forwarder/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    forwarder_log_enabled = true
    s3_buckets            = ["cloudtrail-audit-bucket"]
    s3_bucket_kms_arns    = ["arn:aws:kms:us-west-2:1234567890:key/b204f3d2-1111-2222-94333332-4444ccc222"]
  }
  ```

  To enable Datadog forwarder for a S3 bucket with prefix:
  ```hcl
  module "datadog_lambda_forwarder" {
    source = "cloudposse/datadog-lambda-forwarder/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    forwarder_log_enabled = true
    s3_buckets_with_prefixes = {
      MyBucketWithPrefix = {bucket_name = "my-bucket-with-prefix", bucket_prefix = "events/"}
      AnotherWithPrefix  = {bucket_name = "another-with-prefix", bucket_prefix = "records/"}
    }
    s3_bucket_kms_arns       = ["arn:aws:kms:us-west-2:1234567890:key/b204f3d2-1111-2222-94333332-4444ccc222"]
  }
  ```

  To enable Datadog forwarder for RDS authentication CloudWatch logs:
  ```hcl
  module "datadog_lambda_forwarder" {
    source = "cloudposse/datadog-lambda-forwarder/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    forwarder_log_enabled = true
    cloudwatch_forwarder_log_groups = {
      postgres = {
        name           = "/aws/rds/cluster/pg-main/postgresql"
        filter_pattern = ""
      }
    }
  }
  ```

  To enable Datadog forwarder for VPC Flow Logs CloudWatch logs:
  ```hcl
  module "datadog_lambda_forwarder" {
    source = "cloudposse/datadog-lambda-forwarder/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    forwarder_vpc_logs_enabled   = true
    vpclogs_cloudwatch_log_group = "/aws/vpc/flowlogs/vpc1"
  }
  ```

  To use a local copy of the lambda code you can specify the artifact url:
  ```hcl
  module "datadog_lambda_forwarder" {
    source = "cloudposse/datadog-lambda-forwarder/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version = "x.x.x"

    forwarder_rds_enabled      = true
    forwarder_rds_artifact_url = file("${path.module}/function.zip")
  }
  ```

# Example usage
examples: |-
  Here is an example of using this module:
  - [`examples/complete`](examples/complete) - complete example of using this module

# How to get started quickly
#quickstart: |-
#  Here's how to get started...

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

# Contributors to this project
contributors: []