on_call_schedule

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

Overview

Name	on_call_schedule
Type	Resource
Id	datadog.service_management.on_call_schedule

Fields

The following fields are returned by SELECT queries:

get_on_call_schedule

Name	Datatype	Description
id	string	The schedule's unique identifier. (example: 3653d3c6-0c75-11ea-ad28-fb5701eabc7d)
attributes	object	Provides core properties of a schedule object such as its name and time zone.
relationships	object	Groups the relationships for a schedule object, referencing layers and teams.
type	string	Schedules resource type. (schedules) (default: schedules, example: schedules)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_on_call_schedule	select	schedule_id	include	Get an On-Call schedule
create_on_call_schedule	insert	data	include	Create a new On-Call schedule
update_on_call_schedule	replace	schedule_id, data	include	Update a new On-Call schedule
delete_on_call_schedule	delete	schedule_id		Delete an On-Call schedule

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
schedule_id	string	The ID of the schedule
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.
include	string	Comma-separated list of included relationships to be returned. Allowed values: teams, layers, layers.members, layers.members.user.

SELECT examples

get_on_call_schedule

Get an On-Call schedule

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

INSERT examples

create_on_call_schedule

Create a new On-Call schedule

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

Manifest

# Description fields are for documentation purposes
- name: on_call_schedule
props:
  - name: data
    description: |
      The core data wrapper for creating a schedule, encompassing attributes, relationships, and the resource type.
    value:
      attributes:
        layers:
          - effective_date: "{{ effective_date }}"
            end_date: "{{ end_date }}"
            interval:
              days: {{ days }}
              seconds: {{ seconds }}
            members: "{{ members }}"
            name: "{{ name }}"
            restrictions: "{{ restrictions }}"
            rotation_start: "{{ rotation_start }}"
            time_zone: "{{ time_zone }}"
        name: "{{ name }}"
        time_zone: "{{ time_zone }}"
      relationships:
        teams:
          data:
            - id: "{{ id }}"
              type: "{{ type }}"
      type: "{{ type }}"
  - name: include
    value: "{{ include }}"
    description: Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.
    description: Comma-separated list of included relationships to be returned. Allowed values: `teams`, `layers`, `layers.members`, `layers.members.user`.

REPLACE examples

update_on_call_schedule

Update a new On-Call schedule

REPLACE datadog.service_management.on_call_schedule
SET 
data = '{{ data }}'
WHERE 
schedule_id = '{{ schedule_id }}' --required
AND data = '{{ data }}' --required
AND include = '{{ include}}'
RETURNING
data,
included;

DELETE examples

delete_on_call_schedule

Delete an On-Call schedule

DELETE FROM datadog.service_management.on_call_schedule
WHERE schedule_id = '{{ schedule_id }}' --required
;