incident_notification_rules

Creates, updates, deletes, gets or lists an incident_notification_rules resource.

Overview

Name	incident_notification_rules
Type	Resource
Id	datadog.service_management.incident_notification_rules

Fields

The following fields are returned by SELECT queries:

get_incident_notification_rule

Name	Datatype	Description
id	string (uuid)	The unique identifier of the notification rule. (example: 00000000-0000-0000-0000-000000000001)
attributes	object	The notification rule's attributes.
relationships	object	The notification rule's resource relationships.
type	string	Notification rules resource type. (example: incident_notification_rules)

list_incident_notification_rules

Name	Datatype	Description
id	string (uuid)	The unique identifier of the notification rule. (example: 00000000-0000-0000-0000-000000000001)
attributes	object	The notification rule's attributes.
relationships	object	The notification rule's resource relationships.
type	string	Notification rules resource type. (example: incident_notification_rules)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_notification_rule	select	id, region	include	Retrieves a specific notification rule by its ID.
list_incident_notification_rules	select	region	include	Lists all notification rules for the organization. Optionally filter by incident type.
create_incident_notification_rule	insert	region, data__data		Creates a new notification rule.
update_incident_notification_rule	replace	id, region, data__data	include	Updates an existing notification rule with a complete replacement.
delete_incident_notification_rule	delete	id, region	include	Deletes a notification rule by its ID.

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
id	string (uuid)	The ID of the notification rule.
region	string	(default: datadoghq.com)
include	string	Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user, incident_type, notification_template

SELECT examples

get_incident_notification_rule

Retrieves a specific notification rule by its ID.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_notification_rules
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
AND include = '{{ include }}'
;

list_incident_notification_rules

Lists all notification rules for the organization. Optionally filter by incident type.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_notification_rules
WHERE region = '{{ region }}' -- required
AND include = '{{ include }}'
;

INSERT examples

create_incident_notification_rule

Creates a new notification rule.

INSERT INTO datadog.service_management.incident_notification_rules (
data__data,
region
)
SELECT 
'{{ data }}' /* required */,
'{{ region }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: incident_notification_rules
  props:
    - name: region
      value: string
      description: Required parameter for the incident_notification_rules resource.
    - name: data
      value: object
      description: |
        Notification rule data for a create request.

REPLACE examples

update_incident_notification_rule

Updates an existing notification rule with a complete replacement.

REPLACE datadog.service_management.incident_notification_rules
SET 
data__data = '{{ data }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND data__data = '{{ data }}' --required
AND include = '{{ include}}'
RETURNING
data,
included;

DELETE examples

delete_incident_notification_rule

Deletes a notification rule by its ID.

DELETE FROM datadog.service_management.incident_notification_rules
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND include = '{{ include }}'
;