playbook_details

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

Overview

Name	playbook_details
Type	Resource
Id	sumologic.monitors.playbook_details

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	ids, region		Get the details of the playbooks with the specified identifiers.

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
ids	array	A comma-separated list of playbook identifiers. (example: 649074b5b3d402d6e80b0d1d,649074b7b3d402d6e80b0da1,649074b6b3d402d6e80b0d75)
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)

SELECT examples

list

Get the details of the playbooks with the specified identifiers.

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