Playbook

Rootly v3.3.0, May 7 26

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Example Usage

resource "rootly_playbook" "database_outage" {
  title        = "Database Outage Response"
  summary      = "Steps to follow when a database outage occurs"
  severity_ids = [rootly_severity.sev0.id, rootly_severity.sev1.id]
  service_ids  = [rootly_service.elasticsearch_prod.id]
}

Create Playbook Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Playbook(name: string, args: PlaybookArgs, opts?: CustomResourceOptions);

@overload
def Playbook(resource_name: str,
             args: PlaybookArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Playbook(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             title: Optional[str] = None,
             environment_ids: Optional[Sequence[str]] = None,
             external_url: Optional[str] = None,
             functionality_ids: Optional[Sequence[str]] = None,
             group_ids: Optional[Sequence[str]] = None,
             incident_type_ids: Optional[Sequence[str]] = None,
             service_ids: Optional[Sequence[str]] = None,
             severity_ids: Optional[Sequence[str]] = None,
             summary: Optional[str] = None)

func NewPlaybook(ctx *Context, name string, args PlaybookArgs, opts ...ResourceOption) (*Playbook, error)

public Playbook(string name, PlaybookArgs args, CustomResourceOptions? opts = null)

public Playbook(String name, PlaybookArgs args)
public Playbook(String name, PlaybookArgs args, CustomResourceOptions options)

type: rootly:Playbook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args PlaybookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args PlaybookArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args PlaybookArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args PlaybookArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args PlaybookArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var playbookResource = new Rootly.Playbook("playbookResource", new()
{
    Title = "string",
    EnvironmentIds = new[]
    {
        "string",
    },
    ExternalUrl = "string",
    FunctionalityIds = new[]
    {
        "string",
    },
    GroupIds = new[]
    {
        "string",
    },
    IncidentTypeIds = new[]
    {
        "string",
    },
    ServiceIds = new[]
    {
        "string",
    },
    SeverityIds = new[]
    {
        "string",
    },
    Summary = "string",
});

example, err := rootly.NewPlaybook(ctx, "playbookResource", &rootly.PlaybookArgs{
	Title: pulumi.String("string"),
	EnvironmentIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ExternalUrl: pulumi.String("string"),
	FunctionalityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	IncidentTypeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ServiceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	SeverityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Summary: pulumi.String("string"),
})

var playbookResource = new Playbook("playbookResource", PlaybookArgs.builder()
    .title("string")
    .environmentIds("string")
    .externalUrl("string")
    .functionalityIds("string")
    .groupIds("string")
    .incidentTypeIds("string")
    .serviceIds("string")
    .severityIds("string")
    .summary("string")
    .build());

playbook_resource = rootly.Playbook("playbookResource",
    title="string",
    environment_ids=["string"],
    external_url="string",
    functionality_ids=["string"],
    group_ids=["string"],
    incident_type_ids=["string"],
    service_ids=["string"],
    severity_ids=["string"],
    summary="string")

const playbookResource = new rootly.Playbook("playbookResource", {
    title: "string",
    environmentIds: ["string"],
    externalUrl: "string",
    functionalityIds: ["string"],
    groupIds: ["string"],
    incidentTypeIds: ["string"],
    serviceIds: ["string"],
    severityIds: ["string"],
    summary: "string",
});

type: rootly:Playbook
properties:
    environmentIds:
        - string
    externalUrl: string
    functionalityIds:
        - string
    groupIds:
        - string
    incidentTypeIds:
        - string
    serviceIds:
        - string
    severityIds:
        - string
    summary: string
    title: string

Playbook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Playbook resource accepts the following input properties:

Title string: The title of the playbook
EnvironmentIds List<string>: The Environment IDs to attach to the incident
ExternalUrl string: The external url of the playbook
FunctionalityIds List<string>: The Functionality IDs to attach to the incident
GroupIds List<string>: The Team IDs to attach to the incident
IncidentTypeIds List<string>: The Incident Type IDs to attach to the incident
ServiceIds List<string>: The Service IDs to attach to the incident
SeverityIds List<string>: The Severity IDs to attach to the incident
Summary string: The summary of the playbook

Title string: The title of the playbook
EnvironmentIds []string: The Environment IDs to attach to the incident
ExternalUrl string: The external url of the playbook
FunctionalityIds []string: The Functionality IDs to attach to the incident
GroupIds []string: The Team IDs to attach to the incident
IncidentTypeIds []string: The Incident Type IDs to attach to the incident
ServiceIds []string: The Service IDs to attach to the incident
SeverityIds []string: The Severity IDs to attach to the incident
Summary string: The summary of the playbook

title String: The title of the playbook
environmentIds List<String>: The Environment IDs to attach to the incident
externalUrl String: The external url of the playbook
functionalityIds List<String>: The Functionality IDs to attach to the incident
groupIds List<String>: The Team IDs to attach to the incident
incidentTypeIds List<String>: The Incident Type IDs to attach to the incident
serviceIds List<String>: The Service IDs to attach to the incident
severityIds List<String>: The Severity IDs to attach to the incident
summary String: The summary of the playbook

title string: The title of the playbook
environmentIds string[]: The Environment IDs to attach to the incident
externalUrl string: The external url of the playbook
functionalityIds string[]: The Functionality IDs to attach to the incident
groupIds string[]: The Team IDs to attach to the incident
incidentTypeIds string[]: The Incident Type IDs to attach to the incident
serviceIds string[]: The Service IDs to attach to the incident
severityIds string[]: The Severity IDs to attach to the incident
summary string: The summary of the playbook

title str: The title of the playbook
environment_ids Sequence[str]: The Environment IDs to attach to the incident
external_url str: The external url of the playbook
functionality_ids Sequence[str]: The Functionality IDs to attach to the incident
group_ids Sequence[str]: The Team IDs to attach to the incident
incident_type_ids Sequence[str]: The Incident Type IDs to attach to the incident
service_ids Sequence[str]: The Service IDs to attach to the incident
severity_ids Sequence[str]: The Severity IDs to attach to the incident
summary str: The summary of the playbook

title String: The title of the playbook
environmentIds List<String>: The Environment IDs to attach to the incident
externalUrl String: The external url of the playbook
functionalityIds List<String>: The Functionality IDs to attach to the incident
groupIds List<String>: The Team IDs to attach to the incident
incidentTypeIds List<String>: The Incident Type IDs to attach to the incident
serviceIds List<String>: The Service IDs to attach to the incident
severityIds List<String>: The Severity IDs to attach to the incident
summary String: The summary of the playbook

Outputs

All input properties are implicitly available as output properties. Additionally, the Playbook resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing Playbook Resource

Get an existing Playbook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PlaybookState, opts?: CustomResourceOptions): Playbook

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        environment_ids: Optional[Sequence[str]] = None,
        external_url: Optional[str] = None,
        functionality_ids: Optional[Sequence[str]] = None,
        group_ids: Optional[Sequence[str]] = None,
        incident_type_ids: Optional[Sequence[str]] = None,
        service_ids: Optional[Sequence[str]] = None,
        severity_ids: Optional[Sequence[str]] = None,
        summary: Optional[str] = None,
        title: Optional[str] = None) -> Playbook

func GetPlaybook(ctx *Context, name string, id IDInput, state *PlaybookState, opts ...ResourceOption) (*Playbook, error)

public static Playbook Get(string name, Input<string> id, PlaybookState? state, CustomResourceOptions? opts = null)

public static Playbook get(String name, Output<String> id, PlaybookState state, CustomResourceOptions options)

resources:  _:    type: rootly:Playbook    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

EnvironmentIds List<string>: The Environment IDs to attach to the incident
ExternalUrl string: The external url of the playbook
FunctionalityIds List<string>: The Functionality IDs to attach to the incident
GroupIds List<string>: The Team IDs to attach to the incident
IncidentTypeIds List<string>: The Incident Type IDs to attach to the incident
ServiceIds List<string>: The Service IDs to attach to the incident
SeverityIds List<string>: The Severity IDs to attach to the incident
Summary string: The summary of the playbook
Title string: The title of the playbook

EnvironmentIds []string: The Environment IDs to attach to the incident
ExternalUrl string: The external url of the playbook
FunctionalityIds []string: The Functionality IDs to attach to the incident
GroupIds []string: The Team IDs to attach to the incident
IncidentTypeIds []string: The Incident Type IDs to attach to the incident
ServiceIds []string: The Service IDs to attach to the incident
SeverityIds []string: The Severity IDs to attach to the incident
Summary string: The summary of the playbook
Title string: The title of the playbook

environmentIds List<String>: The Environment IDs to attach to the incident
externalUrl String: The external url of the playbook
functionalityIds List<String>: The Functionality IDs to attach to the incident
groupIds List<String>: The Team IDs to attach to the incident
incidentTypeIds List<String>: The Incident Type IDs to attach to the incident
serviceIds List<String>: The Service IDs to attach to the incident
severityIds List<String>: The Severity IDs to attach to the incident
summary String: The summary of the playbook
title String: The title of the playbook

environmentIds string[]: The Environment IDs to attach to the incident
externalUrl string: The external url of the playbook
functionalityIds string[]: The Functionality IDs to attach to the incident
groupIds string[]: The Team IDs to attach to the incident
incidentTypeIds string[]: The Incident Type IDs to attach to the incident
serviceIds string[]: The Service IDs to attach to the incident
severityIds string[]: The Severity IDs to attach to the incident
summary string: The summary of the playbook
title string: The title of the playbook

environment_ids Sequence[str]: The Environment IDs to attach to the incident
external_url str: The external url of the playbook
functionality_ids Sequence[str]: The Functionality IDs to attach to the incident
group_ids Sequence[str]: The Team IDs to attach to the incident
incident_type_ids Sequence[str]: The Incident Type IDs to attach to the incident
service_ids Sequence[str]: The Service IDs to attach to the incident
severity_ids Sequence[str]: The Severity IDs to attach to the incident
summary str: The summary of the playbook
title str: The title of the playbook

environmentIds List<String>: The Environment IDs to attach to the incident
externalUrl String: The external url of the playbook
functionalityIds List<String>: The Functionality IDs to attach to the incident
groupIds List<String>: The Team IDs to attach to the incident
incidentTypeIds List<String>: The Incident Type IDs to attach to the incident
serviceIds List<String>: The Service IDs to attach to the incident
severityIds List<String>: The Severity IDs to attach to the incident
summary String: The summary of the playbook
title String: The title of the playbook

Import

rootly.Playbook can be imported using the import command.

$ pulumi import rootly:index/playbook:Playbook primary a816421c-6ceb-481a-87c4-585e47451f24

Or using an import block.

Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

HCL can be generated from the import block using the -generate-config-out flag.

pulumi preview -generate-config-out=generated.tf

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: rootly rootlyhq/pulumi-rootly
License: Apache-2.0
Notes: This Pulumi package is based on the rootly Terraform Provider.

Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

rootly.Playbook

On this page

On this page

Example Usage

Create Playbook Resource

Constructor syntax

Parameters

Constructor example

Playbook Resource Properties

Inputs

Outputs

Look up Existing Playbook Resource

Import

Package Details

On this page

On this page