1. Packages
  2. Rootly
  3. API Docs
  4. Playbook
Rootly v1.0.1 published on Friday, Jun 2, 2023 by Rootly

rootly.Playbook

Explore with Pulumi AI

rootly logo
Rootly v1.0.1 published on Friday, Jun 2, 2023 by Rootly

    Create Playbook Resource

    new Playbook(name: string, args: PlaybookArgs, opts?: CustomResourceOptions);
    @overload
    def Playbook(resource_name: 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,
                 severity_ids: Optional[Sequence[str]] = None,
                 summary: Optional[str] = None,
                 title: Optional[str] = None)
    @overload
    def Playbook(resource_name: str,
                 args: PlaybookArgs,
                 opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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

    The Playbook resource accepts the following input properties:

    Title string

    The title of the playbook

    EnvironmentIds List<string>

    The Environment ID's to attach to the incident

    ExternalUrl string

    The external url of the playbook

    FunctionalityIds List<string>

    The Functionality ID's to attach to the incident

    GroupIds List<string>

    The Team ID's to attach to the incident

    IncidentTypeIds List<string>

    The Incident Type ID's to attach to the incident

    SeverityIds List<string>

    The Severity ID's to attach to the incident

    Summary string

    The summary of the playbook

    Title string

    The title of the playbook

    EnvironmentIds []string

    The Environment ID's to attach to the incident

    ExternalUrl string

    The external url of the playbook

    FunctionalityIds []string

    The Functionality ID's to attach to the incident

    GroupIds []string

    The Team ID's to attach to the incident

    IncidentTypeIds []string

    The Incident Type ID's to attach to the incident

    SeverityIds []string

    The Severity ID's to attach to the incident

    Summary string

    The summary of the playbook

    title String

    The title of the playbook

    environmentIds List<String>

    The Environment ID's to attach to the incident

    externalUrl String

    The external url of the playbook

    functionalityIds List<String>

    The Functionality ID's to attach to the incident

    groupIds List<String>

    The Team ID's to attach to the incident

    incidentTypeIds List<String>

    The Incident Type ID's to attach to the incident

    severityIds List<String>

    The Severity ID's to attach to the incident

    summary String

    The summary of the playbook

    title string

    The title of the playbook

    environmentIds string[]

    The Environment ID's to attach to the incident

    externalUrl string

    The external url of the playbook

    functionalityIds string[]

    The Functionality ID's to attach to the incident

    groupIds string[]

    The Team ID's to attach to the incident

    incidentTypeIds string[]

    The Incident Type ID's to attach to the incident

    severityIds string[]

    The Severity ID's 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 ID's to attach to the incident

    external_url str

    The external url of the playbook

    functionality_ids Sequence[str]

    The Functionality ID's to attach to the incident

    group_ids Sequence[str]

    The Team ID's to attach to the incident

    incident_type_ids Sequence[str]

    The Incident Type ID's to attach to the incident

    severity_ids Sequence[str]

    The Severity ID's to attach to the incident

    summary str

    The summary of the playbook

    title String

    The title of the playbook

    environmentIds List<String>

    The Environment ID's to attach to the incident

    externalUrl String

    The external url of the playbook

    functionalityIds List<String>

    The Functionality ID's to attach to the incident

    groupIds List<String>

    The Team ID's to attach to the incident

    incidentTypeIds List<String>

    The Incident Type ID's to attach to the incident

    severityIds List<String>

    The Severity ID's 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,
            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)
    Resource lookup is not supported in YAML
    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 ID's to attach to the incident

    ExternalUrl string

    The external url of the playbook

    FunctionalityIds List<string>

    The Functionality ID's to attach to the incident

    GroupIds List<string>

    The Team ID's to attach to the incident

    IncidentTypeIds List<string>

    The Incident Type ID's to attach to the incident

    SeverityIds List<string>

    The Severity ID's to attach to the incident

    Summary string

    The summary of the playbook

    Title string

    The title of the playbook

    EnvironmentIds []string

    The Environment ID's to attach to the incident

    ExternalUrl string

    The external url of the playbook

    FunctionalityIds []string

    The Functionality ID's to attach to the incident

    GroupIds []string

    The Team ID's to attach to the incident

    IncidentTypeIds []string

    The Incident Type ID's to attach to the incident

    SeverityIds []string

    The Severity ID's to attach to the incident

    Summary string

    The summary of the playbook

    Title string

    The title of the playbook

    environmentIds List<String>

    The Environment ID's to attach to the incident

    externalUrl String

    The external url of the playbook

    functionalityIds List<String>

    The Functionality ID's to attach to the incident

    groupIds List<String>

    The Team ID's to attach to the incident

    incidentTypeIds List<String>

    The Incident Type ID's to attach to the incident

    severityIds List<String>

    The Severity ID's to attach to the incident

    summary String

    The summary of the playbook

    title String

    The title of the playbook

    environmentIds string[]

    The Environment ID's to attach to the incident

    externalUrl string

    The external url of the playbook

    functionalityIds string[]

    The Functionality ID's to attach to the incident

    groupIds string[]

    The Team ID's to attach to the incident

    incidentTypeIds string[]

    The Incident Type ID's to attach to the incident

    severityIds string[]

    The Severity ID's 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 ID's to attach to the incident

    external_url str

    The external url of the playbook

    functionality_ids Sequence[str]

    The Functionality ID's to attach to the incident

    group_ids Sequence[str]

    The Team ID's to attach to the incident

    incident_type_ids Sequence[str]

    The Incident Type ID's to attach to the incident

    severity_ids Sequence[str]

    The Severity ID's to attach to the incident

    summary str

    The summary of the playbook

    title str

    The title of the playbook

    environmentIds List<String>

    The Environment ID's to attach to the incident

    externalUrl String

    The external url of the playbook

    functionalityIds List<String>

    The Functionality ID's to attach to the incident

    groupIds List<String>

    The Team ID's to attach to the incident

    incidentTypeIds List<String>

    The Incident Type ID's to attach to the incident

    severityIds List<String>

    The Severity ID's to attach to the incident

    summary String

    The summary of the playbook

    title String

    The title of the playbook

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the rootly Terraform Provider.

    rootly logo
    Rootly v1.0.1 published on Friday, Jun 2, 2023 by Rootly