From 5f9a7a7219466e9f14d3c9285c13d3a2fc092e26 Mon Sep 17 00:00:00 2001 From: Omero Saienni Date: Tue, 10 Sep 2024 11:47:02 +1200 Subject: [PATCH] Add new configuration document for connection datadog --- .../config-files/connection/datadog.md | 37 +++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/reference/config-files/connection/datadog.md diff --git a/docs/reference/config-files/connection/datadog.md b/docs/reference/config-files/connection/datadog.md new file mode 100644 index 0000000..43e2e00 --- /dev/null +++ b/docs/reference/config-files/connection/datadog.md @@ -0,0 +1,37 @@ +--- +title: datadog +sidebar_label: datadog +--- + +# datadog + +The `datadog` connection can be used to access Datadog resources. + +```hcl +connection "datadog" "my_datadog_connection" { + api_key = "b1cf234................." + app_key = "1a2345bc..................." + api_url = "https://api.adoghq.com/" +} +``` + +## Arguments + +| Name | Type | Required? | Description | +| --------- | ------ | --------- | --------------- | +| `api_key` | String | Optional | API key | +| `app_key` | String | Optional | Application key | +| `api_url` | String | Optional | API URL | + +All arguments are optional, and a `datadog` connection with no arguments will behave the same as the [default connection](#default-connection). + +## Default Connection + +The `datadog` connection type includes an implicit, default connection (`connection.datadog.default`) that will be configured using the environment variables `DD_CLIENT_API_KEY`, and `DD_CLIENT_APP_KEY`. + +```hcl +connection "datadog" "my_datadog_connection" { + api_key = env("DD_CLIENT_API_KEY") + app_key = env("DD_CLIENT_APP_KEY") +} +```