config_policies
Creates, updates, deletes, gets or lists a config_policies
resource.
Overview
Name | config_policies |
Type | Resource |
Id | datadog.monitoring.config_policies |
Fields
The following fields are returned by SELECT
queries:
- get_monitor_config_policy
- list_monitor_config_policies
Name | Datatype | Description |
---|---|---|
id | string | ID of this monitor configuration policy. (example: 00000000-0000-1234-0000-000000000000) |
attributes | object | Policy and policy type for a monitor configuration policy. |
type | string | Monitor configuration policy resource type. (default: monitor-config-policy, example: monitor-config-policy) |
Name | Datatype | Description |
---|---|---|
id | string | ID of this monitor configuration policy. (example: 00000000-0000-1234-0000-000000000000) |
attributes | object | Policy and policy type for a monitor configuration policy. |
type | string | Monitor configuration policy resource type. (default: monitor-config-policy, example: monitor-config-policy) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
get_monitor_config_policy | select | policy_id , region | Get a monitor configuration policy by policy_id . | |
list_monitor_config_policies | select | region | Get all monitor configuration policies. | |
create_monitor_config_policy | insert | region , data__data | Create a monitor configuration policy. | |
update_monitor_config_policy | update | policy_id , region , data__data | Edit a monitor configuration policy. | |
delete_monitor_config_policy | delete | policy_id , region | Delete a monitor configuration policy. |
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 |
---|---|---|
policy_id | string | ID of the monitor configuration policy. |
region | string | (default: datadoghq.com) |
SELECT
examples
- get_monitor_config_policy
- list_monitor_config_policies
Get a monitor configuration policy by policy_id
.
SELECT
id,
attributes,
type
FROM datadog.monitoring.config_policies
WHERE policy_id = '{{ policy_id }}' -- required
AND region = '{{ region }}' -- required
;
Get all monitor configuration policies.
SELECT
id,
attributes,
type
FROM datadog.monitoring.config_policies
WHERE region = '{{ region }}' -- required
;
INSERT
examples
- create_monitor_config_policy
- Manifest
Create a monitor configuration policy.
INSERT INTO datadog.monitoring.config_policies (
data__data,
region
)
SELECT
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data
;
# Description fields are for documentation purposes
- name: config_policies
props:
- name: region
value: string
description: Required parameter for the config_policies resource.
- name: data
value: object
description: |
A monitor configuration policy data.
UPDATE
examples
- update_monitor_config_policy
Edit a monitor configuration policy.
UPDATE datadog.monitoring.config_policies
SET
data__data = '{{ data }}'
WHERE
policy_id = '{{ policy_id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
RETURNING
data;
DELETE
examples
- delete_monitor_config_policy
Delete a monitor configuration policy.
DELETE FROM datadog.monitoring.config_policies
WHERE policy_id = '{{ policy_id }}' --required
AND region = '{{ region }}' --required
;