incident_user_defined_roles

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

Overview

Name	incident_user_defined_roles
Type	Resource
Id	datadog.service_management.incident_user_defined_roles

Fields

The following fields are returned by SELECT queries:

get_incident_user_defined_role

Name	Datatype	Description
id	string (uuid)	The ID of the user-defined role. (example: 00000000-0000-0000-0000-000000000002)
attributes	object	Attributes of an incident user-defined role.
relationships	object	Relationships of a user-defined role response.
type	string	Incident user-defined role resource type. (incident_user_defined_roles) (example: incident_user_defined_roles)

list_incident_user_defined_roles

Name	Datatype	Description
id	string (uuid)	The ID of the user-defined role. (example: 00000000-0000-0000-0000-000000000002)
attributes	object	Attributes of an incident user-defined role.
relationships	object	Relationships of a user-defined role response.
type	string	Incident user-defined role resource type. (incident_user_defined_roles) (example: incident_user_defined_roles)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_incident_user_defined_role	select	role_id	include	Retrieve a single user-defined role for incidents.
list_incident_user_defined_roles	select		filter[incident-type], include	List all user-defined roles for incidents.
create_incident_user_defined_role	insert	data	include	Create a new user-defined role for incidents.
update_incident_user_defined_role	update	role_id, data	include	Update an existing user-defined role for incidents.
delete_incident_user_defined_role	delete	role_id		Delete an existing user-defined role for incidents.

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
role_id	string (uuid)	The UUID of the incident user-defined role.
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.
filter[incident-type]	string (uuid)	Filter roles by incident type UUID.
include	string	Comma-separated list of related resources to include in the response.

SELECT examples

get_incident_user_defined_role

Retrieve a single user-defined role for incidents.

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

list_incident_user_defined_roles

List all user-defined roles for incidents.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_user_defined_roles
WHERE filter[incident-type] = '{{ filter[incident-type] }}'
AND include = '{{ include }}'
;

INSERT examples

create_incident_user_defined_role

Create a new user-defined role for incidents.

INSERT INTO datadog.service_management.incident_user_defined_roles (
data,
include
)
SELECT 
'{{ data }}' /* required */,
'{{ include }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: incident_user_defined_roles
props:
  - name: data
    description: |
      Data for creating an incident user-defined role.
    value:
      attributes:
        description: "{{ description }}"
        name: "{{ name }}"
        policy:
          is_single: {{ is_single }}
      relationships:
        incident_type:
          data:
            id: "{{ id }}"
            type: "{{ type }}"
      type: "{{ type }}"
  - name: include
    value: "{{ include }}"
    description: Comma-separated list of related resources to include in the response.
    description: Comma-separated list of related resources to include in the response.

UPDATE examples

update_incident_user_defined_role

Update an existing user-defined role for incidents.

UPDATE datadog.service_management.incident_user_defined_roles
SET 
data = '{{ data }}'
WHERE 
role_id = '{{ role_id }}' --required
AND data = '{{ data }}' --required
AND include = '{{ include}}'
RETURNING
data,
included;

DELETE examples

delete_incident_user_defined_role

Delete an existing user-defined role for incidents.

DELETE FROM datadog.service_management.incident_user_defined_roles
WHERE role_id = '{{ role_id }}' --required
;