Skip to main content

Component: datadog-monitor

This component is responsible for provisioning Datadog monitors and assigning Datadog roles to the monitors.

It's required that the DataDog API and APP secret keys are available in the consuming account at the var.datadog_api_secret_key and var.datadog_app_secret_key paths in the AWS SSM Parameter Store.


Stack Level: Regional

Here's an example snippet for how to use this component:

workspace_enabled: true
enabled: true
secrets_store_type: SSM
- "catalog/monitors/dev/*.yaml"
# Assign roles to monitors to allow/restrict access
- "corporate-it-dev"
- "development-dev"
- "site-reliability-dev"
- "corporate-it-dev"
- "development-dev"
- "site-reliability-dev"


terraform>= 1.0.0
aws>= 4.9.0
datadog>= 3.3.0


No providers.




No resources.


additional_tag_mapAdditional 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.
alert_tagsList of alert tags to add to all alert messages, e.g. ["@opsgenie"] or ["@devops", "@opsgenie"]list(string)nullno
alert_tags_separatorSeparator for the alert tags. All strings from the alert_tags variable will be joined into one string using the separator and then added to the alert messagestring"\n"no
attributesID 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.
contextSingle 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.
"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": [
"name": null,
"namespace": null,
"regex_replace_chars": null,
"stage": null,
"tags": {},
"tenant": null
datadog_api_secret_keyThe key of the Datadog API secretstring"datadog/datadog_api_key"no
datadog_app_secret_keyThe key of the Datadog Application secretstring"datadog/datadog_app_key"no
datadog_monitor_context_tagsList of context tags to add to each monitorset(string)
datadog_monitor_context_tags_enabledWhether to add context tags to each monitorbooltrueno
datadog_monitor_globalsGlobal parameters to add to each monitorany{}no
datadog_monitors_config_parametersMap of parameters to Datadog monitor configurationsmap(any){}no
datadog_secrets_source_store_accountAccount (stage) holding Secret Store for Datadog API and app keys.string"corp"no
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.
descriptor_formatsDescribe 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).
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
id_length_limitLimit 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.
import_profile_nameAWS Profile name to use when importing a resourcestringnullno
import_role_arnIAM Role ARN to use when importing a resourcestringnullno
label_key_caseControls 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.
label_orderThe 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.
label_value_caseControls 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.
labels_as_tagsSet 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.
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.
local_datadog_monitors_config_pathsList of paths to local Datadog monitor configurationslist(string)[]no
message_postfixAdditional information to put after each monitor messagestring""no
message_prefixAdditional information to put before each monitor messagestring""no
monitors_roles_mapMap of Datadog monitor names to a set of Datadog role names to restrict access to the monitorsmap(set(string)){}no
nameID 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.
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.
regionAWS Regionstringn/ayes
remote_datadog_monitors_base_pathBase path to remote Datadog monitor configurationsstring""no
remote_datadog_monitors_config_pathsList of paths to remote Datadog monitor configurationslist(string)[]no
role_pathsList of paths to Datadog role configurationslist(string)[]no
secrets_store_typeSecret store type for Datadog API and app keys. Valid values: SSM, ASMstring"SSM"no
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno


datadog_monitor_namesNames of the created Datadog monitors