Skip to main content

Component: datadog-configuration

This component is responsible for provisioning SSM or ASM entries for Datadog API keys.

It's required that the DataDog API and APP secret keys are available in the var.datadog_secrets_source_store_account account in AWS SSM Parameter Store at the /datadog/%v/datadog_app_key paths (where %v are the corresponding account names).

This component copies keys from the source account (e.g. auto) to the destination account where this is being deployed. The purpose of using this formatted copying of keys handles a couple of problems.

  1. The keys are needed in each account where datadog resources will be deployed.
  2. The keys might need to be different per account or tenant, or any subset of accounts.
  3. If the keys need to be rotated they can be rotated from a single management account.

This module also has a submodule which allows other resources to quickly use it to create a datadog provider.

See Datadog's documentation about provisioning keys for more information.


Stack Level: Global

This component should be deployed to every account where you want to provision datadog resources. This is usually every account except root and identity

Here's an example snippet for how to use this component. It's suggested to apply this component to all accounts which you want to track AWS metrics with DataDog. In this example we use the key paths /datadog/%v/datadog_api_key and /datadog/%v/datadog_app_key where %v is default, this can be changed through datadog_app_secret_key & datadog_api_secret_key variables. The output Keys in the deployed account will be /datadog/datadog_api_key and /datadog/datadog_app_key.

workspace_enabled: true
enabled: true
name: datadog-configuration
datadog_secrets_store_type: SSM
datadog_secrets_source_store_account_stage: auto
datadog_secrets_source_store_account_region: "us-east-2"

Here is a snippet of using the datadog_keys submodule:

module "datadog_configuration" {
source = "../datadog-configuration/modules/datadog_keys"
enabled = true
context = module.this.context

provider "datadog" {
api_key = module.datadog_configuration.datadog_api_key
app_key = module.datadog_configuration.datadog_app_key
api_url = module.datadog_configuration.datadog_api_url
validate = local.enabled


terraform>= 1.0.0
aws>= 4.9.0


aws.api_keys>= 4.9.0




aws_secretsmanager_secret.datadog_api_keydata source
aws_secretsmanager_secret.datadog_app_keydata source
aws_secretsmanager_secret_version.datadog_api_keydata source
aws_secretsmanager_secret_version.datadog_app_keydata source
aws_ssm_parameter.datadog_api_keydata source
aws_ssm_parameter.datadog_app_keydata source


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.
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 name of the Datadog API secretstring"default"no
datadog_api_secret_key_source_patternThe format string (%v will be replaced by the var.datadog_api_secret_key) for the key of the Datadog API secret in the source accountstring"/datadog/%v/datadog_api_key"no
datadog_api_secret_key_target_patternThe format string (%v will be replaced by the var.datadog_api_secret_key) for the key of the Datadog API secret in the target accountstring"/datadog/datadog_api_key"no
datadog_app_secret_keyThe name of the Datadog APP secretstring"default"no
datadog_app_secret_key_source_patternThe format string (%v will be replaced by the var.datadog_app_secret_key) for the key of the Datadog APP secret in the source accountstring"/datadog/%v/datadog_app_key"no
datadog_app_secret_key_target_patternThe format string (%v will be replaced by the var.datadog_api_secret_key) for the key of the Datadog APP secret in the target accountstring"/datadog/datadog_app_key"no
datadog_secrets_source_store_account_regionRegion for holding Secret Store Datadog Keys, leave as null to use the same region as the stackstringnullno
datadog_secrets_source_store_account_stageStage holding Secret Store for Datadog API and app keys.string"auto"no
datadog_secrets_source_store_account_tenantTenant holding Secret Store for Datadog API and app keys.string"core"no
datadog_secrets_store_typeSecret Store type for Datadog API and app keys. Valid values: SSM, ASMstring"SSM"no
datadog_site_urlThe Datadog Site URL,
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.
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.
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
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_api_key_locationThe Datadog API key in the secrets store
datadog_api_urlThe URL of the Datadog API
datadog_app_key_locationThe Datadog APP key location in the secrets store
datadog_secrets_store_typeThe type of the secrets store to use for Datadog API and APP keys
datadog_siteThe Datadog site to use
regionThe region where the keys will be created