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

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. (monitor-config-policy) (default: monitor-config-policy, example: 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. (monitor-config-policy) (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		Get a monitor configuration policy by policy_id.
list_monitor_config_policies	select			Get all monitor configuration policies.
create_monitor_config_policy	insert	data		Create a monitor configuration policy.
update_monitor_config_policy	update	policy_id, data		Edit a monitor configuration policy.
delete_monitor_config_policy	delete	policy_id		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.
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_monitor_config_policy

Get a monitor configuration policy by policy_id.

SELECT
id,
attributes,
type
FROM datadog.monitoring.config_policies
WHERE policy_id = '{{ policy_id }}' -- required
;

list_monitor_config_policies

Get all monitor configuration policies.

SELECT
id,
attributes,
type
FROM datadog.monitoring.config_policies
;

INSERT examples

create_monitor_config_policy

Create a monitor configuration policy.

INSERT INTO datadog.monitoring.config_policies (
data
)
SELECT 
'{{ data }}' /* required */
RETURNING
data
;

Manifest

# Description fields are for documentation purposes
- name: config_policies
props:
  - name: data
    description: |
      A monitor configuration policy data.
    value:
      attributes:
        policy:
          tag_key: "{{ tag_key }}"
          tag_key_required: {{ tag_key_required }}
          valid_tag_values:
            - "{{ valid_tag_values }}"
        policy_type: "{{ policy_type }}"
      type: "{{ type }}"

UPDATE examples

update_monitor_config_policy

Edit a monitor configuration policy.

UPDATE datadog.monitoring.config_policies
SET 
data = '{{ data }}'
WHERE 
policy_id = '{{ policy_id }}' --required
AND 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
;