configs
Creates, updates, deletes, gets or lists a configs resource.
Overview
| Name | configs |
| Type | Resource |
| Id | datadog.organization.configs |
Fields
The following fields are returned by SELECT queries:
- get_org_config
- list_org_configs
| Name | Datatype | Description |
|---|---|---|
id | string | A unique identifier for an Org Config. (example: abcd1234) |
attributes | object | Readable attributes of an Org Config. |
type | string | Data type of an Org Config. (org_configs) (example: org_configs) |
| Name | Datatype | Description |
|---|---|---|
id | string | A unique identifier for an Org Config. (example: abcd1234) |
attributes | object | Readable attributes of an Org Config. |
type | string | Data type of an Org Config. (org_configs) (example: org_configs) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_org_config | select | org_config_name | Return the name, description, and value of a specific Org Config. | |
list_org_configs | select | Returns all Org Configs (name, description, and value). | ||
update_org_config | update | org_config_name, data | Update the value of a specific Org Config. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
org_config_name | string | The name of an Org Config. |
site | string | The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both. |
SELECT examples
- get_org_config
- list_org_configs
Return the name, description, and value of a specific Org Config.
SELECT
id,
attributes,
type
FROM datadog.organization.configs
WHERE org_config_name = '{{ org_config_name }}' -- required
;
Returns all Org Configs (name, description, and value).
SELECT
id,
attributes,
type
FROM datadog.organization.configs
;
UPDATE examples
- update_org_config
Update the value of a specific Org Config.
UPDATE datadog.organization.configs
SET
data = '{{ data }}'
WHERE
org_config_name = '{{ org_config_name }}' --required
AND data = '{{ data }}' --required
RETURNING
data;