README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make init`, `make readme/deps` to load all the dependencies
# then run `make readme` as needed to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-datadog-integration

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - logging
  - monitoring
  - datadog

# Categories of this project
categories:
  - terraform-modules/logging

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

# License of this project
license: "APACHE2"

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

# Badges to display

badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-datadog-integration.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-datadog-integration/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-datadog-integration.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-datadog-integration/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: "fluentd-datadog-logs"
    description: "Dockerfile that implements fluentd log forwarding to datadog's new log service"
    url: "https://github.com/cloudposse/fluentd-datadog-logs"
  - name: "terraform-datadog-monitor"
    description: "Terraform module to provision Standard System Monitors (cpu, memory, swap, io, etc) in Datadog"
    url: "https://github.com/cloudposse/terraform-datadog-monitor"
  - name: "terraform-aws-datadog-lambda-forwarder"
    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)"
    url: "https://github.com/cloudposse/terraform-aws-datadog-lambda-forwarder"

# Short description of this project
description: |-
  Terraform module to configure [Datadog AWS integration](https://docs.datadoghq.com/api/v1/aws-integration/).

# How to use this project
usage: |2-

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

  **Note:** At the moment this module supports a limited set of IAM policies to support Datadog integrations. More can be added as needed.

  ### Structure

  This module follows [Datadog's documentation](https://docs.datadoghq.com/integrations/amazon_web_services/)
  by supporting a `core` integration which is the minimum set of permissions needed for any Datadog integration,
  plus an additional integration per service which contains the additional permissions Datadog has documented
  are required for that service.

  To make things easier, this module also implements an `all` integration which includes all the permissions Datadog
  lists under "All Permissions" as the maximal set of permissions required, so you can just set
  `integrations = ["all"]` and be done.

  ### Installation

  Include this module in your existing terraform code:

  ```hcl
  module "datadog_integration" {
    source = "cloudposse/datadog-integration/aws"
    # Cloud Posse recommends pinning every module to a specific version
    # version     = "x.x.x"

    namespace                  = "eg"
    stage                      = "test"
    name                       = "datadog"
    integrations               = ["all"]
  }
  ```

  The DataDog integration will be linked with your configured datadog account via the provider's `api_key`.

examples: |-
  Review the [complete example](examples/complete) to see how to use this module.

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []