Version: Latest

Module: `datadog-integration`

Terraform module to configure Datadog AWS integration.

Sponsorship

This project is supported by the Datadog Open Source Program.

As part of this collaboration, Datadog provides a dedicated sandbox account that we use for automated integration and acceptance testing. This contribution allows us to continuously validate changes against a real Datadog environment, improving reliability and reducing the risk of regressions.

We are grateful to Datadog for supporting our open source ecosystem and helping ensure that infrastructure code for Terraform remains stable and well-tested

Usage

This module helps set up the AWS integration with Datadog, enabling you to monitor your AWS resources through Datadog's platform.

Features

Configures AWS integration with Datadog
Sets up IAM role for Datadog to assume
Configures metrics collection with flexible filtering
Supports CSPM (Cloud Security Posture Management) and extended resource collection
Configures region-based filtering

Usage

module "datadog_aws_integration" {
  source = "."

  enabled = true

  # Datadog account ID
  datadog_aws_account_id = "datadog-account-id"

  # Optional: Host tags
  host_tags = ["environment:prod", "team:dev"]

  # Optional: Metrics collection settings
  metrics_collection_enabled = true
  metrics_automute_enabled = true
  metrics_collect_cloudwatch_alarms = true
  metrics_collect_custom_metrics = true

  # Optional: Metrics filtering
  namespace_filters_include_only = ["AWS/EC2", "AWS/RDS"]
  namespace_filters_exclude_only = []

  # Optional: Resource collection settings
  extended_resource_collection_enabled = true
  cspm_resource_collection_enabled = true

  # Optional: Region filtering
  excluded_regions = ["cn-north-1", "cn-northwest-1"]
}

Variables

enabled: Whether to enable the integration (default: true)
datadog_aws_account_id: The AWS account ID of your Datadog account
host_tags: Optional list of tags to apply to the integration
metrics_collection_enabled: Enable metrics collection (default: true)
metrics_automute_enabled: Enable automute for metrics (default: true)
metrics_collect_cloudwatch_alarms: Collect CloudWatch alarms (default: true)
metrics_collect_custom_metrics: Collect custom metrics (default: true)
namespace_filters_include_only: List of metric namespaces to include
namespace_filters_exclude_only: List of metric namespaces to exclude
extended_resource_collection_enabled: Enable extended resource collection (default: true)
cspm_resource_collection_enabled: Enable CSPM resource collection (default: true)
excluded_regions: List of AWS regions to exclude from integration

Outputs

iam_role_arn: The ARN of the IAM role created for Datadog
external_id: The external ID used for the IAM role trust relationship

IAM Role

The module creates an IAM role that Datadog can assume to collect metrics and logs from your AWS account. The role includes a trust relationship that allows Datadog's AWS account to assume the role with the proper external ID verification.

Region Filtering

The module supports region-based filtering through the excluded_regions variable. When regions are excluded:

The include_all parameter is set to false
The include_only parameter is set to the list of included regions

When no regions are excluded, include_all is set to true.

Metric Filtering

The module supports flexible metric filtering through:

Namespace filters (include_only/exclude_only)
Tag filters for specific metric namespaces

Security

The module implements security best practices by:

Using external IDs for IAM role trust relationships
Allowing only specific actions in the assume role policy
Requiring proper verification of the Datadog AWS account

Examples

Review the complete example to see how to use this module.

Variables

Required Variables

Optional Variables

account_specific_namespace_rules (map(string)) optional

(DEPRECATED for new resource) An object, (in the form {"namespace1":true/false, "namespace2":true/false} ), that enables or disables metric collection for specific AWS namespaces for this AWS account only. For the datadog_integration_aws_account resource, use 'namespace_filters_include_only' or 'namespace_filters_exclude_only'.

Default value: null

cspm_resource_collection_enabled (bool) optional

Whether Datadog collects cloud security posture management resources from your AWS account.

Default value: false

datadog_aws_account_id (string) optional

The AWS account ID Datadog's integration servers use for all integrations

Default value: "464622532012"

excluded_regions (list(string)) optional

An array of AWS regions to exclude from metrics collection

Default value: null

extended_resource_collection_enabled (bool) optional

Whether Datadog collects additional attributes and configuration information about the resources in your AWS account. Required for cspm_resource_collection_enabled.

Default value: true

filter_tags optional

A list of objects containing namespace and tags to filter metrics collection. Each object should have a namespace and a list of tags in the form key:value.

Type:

list(object({
namespace = string
tags      = list(string)
}))

Default value: null

host_tags (list(string)) optional

An array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration

Default value: null

integrations (list(string)) optional

DEPRECATED: Use the policies variable instead.
List of AWS permission names to apply for different integrations (e.g. 'all', 'core')

Default value: null

metrics_automute_enabled (bool) optional

Enable EC2 automute for AWS metrics.

Default value: true

metrics_collect_cloudwatch_alarms (bool) optional

Enable CloudWatch alarms collection.

Default value: false

metrics_collect_custom_metrics (bool) optional

Enable custom metrics collection.

Default value: false

metrics_collection_enabled (bool) optional

Whether Datadog collects metrics for this AWS account. If null, the provider default is used if the metrics_config block is active.

Default value: null

namespace_filters_exclude_only (list(string)) optional

Exclude only these namespaces from metrics collection. Mutually exclusive with namespace_filters_include_only. If not set and include_only is not set, the provider defaults to excluding ["AWS/SQS", "AWS/ElasticMapReduce"] if the namespace_filters block is active. Use 'datadog_integration_aws_available_namespaces' data source to discover available values.

Default value: null

namespace_filters_include_only (list(string)) optional

Include only these namespaces for metrics collection. Mutually exclusive with namespace_filters_exclude_only. Use 'datadog_integration_aws_available_namespaces' data source to discover available values.

Default value: null

policies (list(string)) optional

List of Datadog's names for AWS IAM policies names to apply to the role.
Valid options are "core-integration", "full-integration", "resource-collection", "CSPM", "SecurityAudit", "everything".
"CSPM" is for Cloud Security Posture Management, which also requires "full-integration".
"SecurityAudit" is for the AWS-managed SecurityAudit Policy.
"everything" means all permissions for offerings.

Default value: [ ]

resource_collection_enabled (bool) optional

DEPRECATED: Use the extended_resource_collection_enabled variables instead.
Whether Datadog collects a standard set of resources from your AWS account.

Default value: null

security_audit_policy_enabled (bool) optional

DEPRECATED: Include SecurityAudit in the policies variable instead.
Enable/disable attaching the AWS managed SecurityAudit policy to the Datadog IAM role to collect information about how AWS resources are configured (used in Datadog Cloud Security Posture Management to read security configuration metadata). If var.cspm_resource_collection_enabled, this is enabled automatically."

Default value: null

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

aws_account_id: AWS Account ID of the IAM Role for Datadog to use for this integration
aws_role_arn: ARN of the AWS IAM Role for Datadog to use for this integration
aws_role_name: Name of the AWS IAM Role for Datadog to use for this integration
datadog_external_id: Datadog integration external ID

Dependencies

Requirements

terraform, version: >= 1.3.0
aws, version: >= 3.0
datadog, version: >= 3.9

Providers

aws, version: >= 3.0
datadog, version: >= 3.9

Modules

Name	Version	Source	Description
`core_label`	0.25.0	`cloudposse/label/null`	n/a
`full_integration_label`	0.25.0	`cloudposse/label/null`	n/a
`resource_collection_label`	0.25.0	`cloudposse/label/null`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_iam_policy.core (resource)
aws_iam_policy.full_integration (resource)
aws_iam_policy.resource_collection (resource)
aws_iam_role.default (resource)
aws_iam_role_policy_attachment.core (resource)
aws_iam_role_policy_attachment.full_integration (resource)
aws_iam_role_policy_attachment.resource_collection (resource)
aws_iam_role_policy_attachment.security_audit (resource)
datadog_integration_aws_account.integration (resource)
datadog_integration_aws_external_id.integration (resource)

Data Sources

The following data sources are used by this module:

aws_caller_identity.current (data source)
aws_iam_policy_document.assume_role (data source)
aws_iam_policy_document.core (data source)
aws_iam_policy_document.full_integration (data source)
aws_iam_policy_document.resource_collection (data source)
aws_partition.current (data source)
aws_regions.available (data source)

Sponsorship​

Usage​

Features​

Usage​

Variables​

Outputs​

IAM Role​

Region Filtering​

Metric Filtering​

Security​

Examples​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Sponsorship

Usage

Features

Usage

Variables

Outputs

IAM Role

Region Filtering

Metric Filtering

Security

Examples

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources