Module: datadog-integration

Terraform module to configure Datadog AWS integration.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see 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 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:

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 to see how to use this module.

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 3.0
datadog	>= 3.9

Providers

Name	Version
aws	>= 3.0
datadog	>= 3.9

Modules

Name	Source	Version
all_label	cloudposse/label/null	0.25.0
core_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_iam_policy.all	resource
aws_iam_policy.core	resource
aws_iam_role.default	resource
aws_iam_role_policy_attachment.all	resource
aws_iam_role_policy_attachment.core	resource
aws_iam_role_policy_attachment.security_audit	resource
datadog_integration_aws.integration	resource
aws_caller_identity.current	data source
aws_iam_policy_document.all	data source
aws_iam_policy_document.assume_role	data source
aws_iam_policy_document.core	data source
aws_partition.current	data source

Inputs

Name	Description	Type	Default	Required
account_specific_namespace_rules	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	map(string)	null	no
additional_tag_map	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.	map(string)	{}	no
attributes	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.	list(string)	[]	no
context	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.	any	{ "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 }	no
cspm_resource_collection_enabled	Whether Datadog collects cloud security posture management resources from your AWS account.	bool	null	no
datadog_aws_account_id	The AWS account ID Datadog's integration servers use for all integrations	string	"464622532012"	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	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).	any	{}	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
excluded_regions	An array of AWS regions to exclude from metrics collection	list(string)	null	no
filter_tags	An array of EC2 tags (in the form key:value) that defines a filter that Datadog use when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used	list(string)	null	no
host_tags	An array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration	list(string)	null	no
id_length_limit	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.	number	null	no
integrations	List of AWS permission names to apply for different integrations (e.g. 'all', 'core')	list(string)	n/a	yes
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
metrics_collection_enabled	Whether Datadog collects metrics for this AWS account.	bool	null	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
regex_replace_chars	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.	string	null	no
resource_collection_enabled	Whether Datadog collects a standard set of resources from your AWS account.	bool	null	no
security_audit_policy_enabled	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.	bool	false	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no

Outputs

Name	Description
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