playbooks

Creates, updates, deletes, gets or lists a playbooks resource.

Overview

Name	playbooks
Type	Resource
Id	sumologic.monitors.playbooks

Fields

The following fields are returned by SELECT queries:

list

The single monitor playbook.

Name	Datatype	Description
name	string	The name of the playbook. (example: Test)
playbook_id	string	The id of the playbook. (example: 1) (wire: playbookId)
version_id	string	The version id of the playbook. (example: 1) (wire: versionId)
description	string	The description of the monitor playbook. (example: <p>30 Seconds API Will Take To Respond</p>)
type	string	The type of the playbook. (example: Analytics)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	region	playbook_type	List all playbooks available to run.

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
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)
playbook_type	string	A string value for playbook type. (example: CSE) (wire: playbookType)

SELECT examples

list

List all playbooks available to run.

SELECT
name,
playbook_id,
version_id,
description,
type
FROM sumologic.monitors.playbooks
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
AND playbook_type = '{{ playbook_type }}'
;