Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Pagerduty Provider
  3. API Docs
  4. ResponsePlay
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-pagerduty

pagerduty.ResponsePlay

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi
pulumi/pulumi-pagerduty

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as pagerduty from "@pulumi/pagerduty";

const example = new pagerduty.User("example", {
    name: "Earline Greenholt",
    email: "125.greenholt.earline@graham.name",
    teams: [examplePagerdutyTeam.id],
});
const exampleEscalationPolicy = new pagerduty.EscalationPolicy("example", {
    name: "Engineering Escalation Policy",
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            type: "user",
            id: example.id,
        }],
    }],
});
const exampleResponsePlay = new pagerduty.ResponsePlay("example", {
    name: "My Response Play",
    from: example.email,
    responders: [{
        type: "escalation_policy_reference",
        id: exampleEscalationPolicy.id,
    }],
    subscribers: [{
        type: "user_reference",
        id: example.id,
    }],
    runnability: "services",
});

    import pulumi
import pulumi_pagerduty as pagerduty

example = pagerduty.User("example",
    name="Earline Greenholt",
    email="125.greenholt.earline@graham.name",
    teams=[example_pagerduty_team["id"]])
example_escalation_policy = pagerduty.EscalationPolicy("example",
    name="Engineering Escalation Policy",
    num_loops=2,
    rules=[{
        "escalation_delay_in_minutes": 10,
        "targets": [{
            "type": "user",
            "id": example.id,
        }],
    }])
example_response_play = pagerduty.ResponsePlay("example",
    name="My Response Play",
    from_=example.email,
    responders=[{
        "type": "escalation_policy_reference",
        "id": example_escalation_policy.id,
    }],
    subscribers=[{
        "type": "user_reference",
        "id": example.id,
    }],
    runnability="services")

    package main

import (
	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := pagerduty.NewUser(ctx, "example", &pagerduty.UserArgs{
			Name:  pulumi.String("Earline Greenholt"),
			Email: pulumi.String("125.greenholt.earline@graham.name"),
			Teams: pulumi.StringArray{
				examplePagerdutyTeam.Id,
			},
		})
		if err != nil {
			return err
		}
		exampleEscalationPolicy, err := pagerduty.NewEscalationPolicy(ctx, "example", &pagerduty.EscalationPolicyArgs{
			Name:     pulumi.String("Engineering Escalation Policy"),
			NumLoops: pulumi.Int(2),
			Rules: pagerduty.EscalationPolicyRuleArray{
				&pagerduty.EscalationPolicyRuleArgs{
					EscalationDelayInMinutes: pulumi.Int(10),
					Targets: pagerduty.EscalationPolicyRuleTargetArray{
						&pagerduty.EscalationPolicyRuleTargetArgs{
							Type: pulumi.String("user"),
							Id:   example.ID(),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = pagerduty.NewResponsePlay(ctx, "example", &pagerduty.ResponsePlayArgs{
			Name: pulumi.String("My Response Play"),
			From: example.Email,
			Responders: pagerduty.ResponsePlayResponderArray{
				&pagerduty.ResponsePlayResponderArgs{
					Type: pulumi.String("escalation_policy_reference"),
					Id:   exampleEscalationPolicy.ID(),
				},
			},
			Subscribers: pagerduty.ResponsePlaySubscriberArray{
				&pagerduty.ResponsePlaySubscriberArgs{
					Type: pulumi.String("user_reference"),
					Id:   example.ID(),
				},
			},
			Runnability: pulumi.String("services"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Pagerduty = Pulumi.Pagerduty;

return await Deployment.RunAsync(() => 
{
    var example = new Pagerduty.User("example", new()
    {
        Name = "Earline Greenholt",
        Email = "125.greenholt.earline@graham.name",
        Teams = new[]
        {
            examplePagerdutyTeam.Id,
        },
    });

    var exampleEscalationPolicy = new Pagerduty.EscalationPolicy("example", new()
    {
        Name = "Engineering Escalation Policy",
        NumLoops = 2,
        Rules = new[]
        {
            new Pagerduty.Inputs.EscalationPolicyRuleArgs
            {
                EscalationDelayInMinutes = 10,
                Targets = new[]
                {
                    new Pagerduty.Inputs.EscalationPolicyRuleTargetArgs
                    {
                        Type = "user",
                        Id = example.Id,
                    },
                },
            },
        },
    });

    var exampleResponsePlay = new Pagerduty.ResponsePlay("example", new()
    {
        Name = "My Response Play",
        From = example.Email,
        Responders = new[]
        {
            new Pagerduty.Inputs.ResponsePlayResponderArgs
            {
                Type = "escalation_policy_reference",
                Id = exampleEscalationPolicy.Id,
            },
        },
        Subscribers = new[]
        {
            new Pagerduty.Inputs.ResponsePlaySubscriberArgs
            {
                Type = "user_reference",
                Id = example.Id,
            },
        },
        Runnability = "services",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.pagerduty.User;
import com.pulumi.pagerduty.UserArgs;
import com.pulumi.pagerduty.EscalationPolicy;
import com.pulumi.pagerduty.EscalationPolicyArgs;
import com.pulumi.pagerduty.inputs.EscalationPolicyRuleArgs;
import com.pulumi.pagerduty.ResponsePlay;
import com.pulumi.pagerduty.ResponsePlayArgs;
import com.pulumi.pagerduty.inputs.ResponsePlayResponderArgs;
import com.pulumi.pagerduty.inputs.ResponsePlaySubscriberArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new User("example", UserArgs.builder()
            .name("Earline Greenholt")
            .email("125.greenholt.earline@graham.name")
            .teams(examplePagerdutyTeam.id())
            .build());

        var exampleEscalationPolicy = new EscalationPolicy("exampleEscalationPolicy", EscalationPolicyArgs.builder()
            .name("Engineering Escalation Policy")
            .numLoops(2)
            .rules(EscalationPolicyRuleArgs.builder()
                .escalationDelayInMinutes(10)
                .targets(EscalationPolicyRuleTargetArgs.builder()
                    .type("user")
                    .id(example.id())
                    .build())
                .build())
            .build());

        var exampleResponsePlay = new ResponsePlay("exampleResponsePlay", ResponsePlayArgs.builder()
            .name("My Response Play")
            .from(example.email())
            .responders(ResponsePlayResponderArgs.builder()
                .type("escalation_policy_reference")
                .id(exampleEscalationPolicy.id())
                .build())
            .subscribers(ResponsePlaySubscriberArgs.builder()
                .type("user_reference")
                .id(example.id())
                .build())
            .runnability("services")
            .build());

    }
}

    resources:
  example:
    type: pagerduty:User
    properties:
      name: Earline Greenholt
      email: 125.greenholt.earline@graham.name
      teams:
        - ${examplePagerdutyTeam.id}
  exampleEscalationPolicy:
    type: pagerduty:EscalationPolicy
    name: example
    properties:
      name: Engineering Escalation Policy
      numLoops: 2
      rules:
        - escalationDelayInMinutes: 10
          targets:
            - type: user
              id: ${example.id}
  exampleResponsePlay:
    type: pagerduty:ResponsePlay
    name: example
    properties:
      name: My Response Play
      from: ${example.email}
      responders:
        - type: escalation_policy_reference
          id: ${exampleEscalationPolicy.id}
      subscribers:
        - type: user_reference
          id: ${example.id}
      runnability: services

    Create ResponsePlay Resource

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

    Constructor syntax

    new ResponsePlay(name: string, args: ResponsePlayArgs, opts?: CustomResourceOptions);
    @overload
def ResponsePlay(resource_name: str,
                 args: ResponsePlayArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def ResponsePlay(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 from_: Optional[str] = None,
                 conference_number: Optional[str] = None,
                 conference_url: Optional[str] = None,
                 description: Optional[str] = None,
                 name: Optional[str] = None,
                 responders: Optional[Sequence[ResponsePlayResponderArgs]] = None,
                 responders_message: Optional[str] = None,
                 runnability: Optional[str] = None,
                 subscribers: Optional[Sequence[ResponsePlaySubscriberArgs]] = None,
                 subscribers_message: Optional[str] = None,
                 team: Optional[str] = None,
                 type: Optional[str] = None)
    func NewResponsePlay(ctx *Context, name string, args ResponsePlayArgs, opts ...ResourceOption) (*ResponsePlay, error)
    public ResponsePlay(string name, ResponsePlayArgs args, CustomResourceOptions? opts = null)
    public ResponsePlay(String name, ResponsePlayArgs args)
public ResponsePlay(String name, ResponsePlayArgs args, CustomResourceOptions options)

    type: pagerduty:ResponsePlay
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 ResponsePlayArgs
    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 ResponsePlayArgs
    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 ResponsePlayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResponsePlayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResponsePlayArgs
    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 responsePlayResource = new Pagerduty.ResponsePlay("responsePlayResource", new()
{
    From = "string",
    ConferenceNumber = "string",
    ConferenceUrl = "string",
    Description = "string",
    Name = "string",
    Responders = new[]
    {
        new Pagerduty.Inputs.ResponsePlayResponderArgs
        {
            Description = "string",
            EscalationRules = new[]
            {
                new Pagerduty.Inputs.ResponsePlayResponderEscalationRuleArgs
                {
                    Targets = new[]
                    {
                        new Pagerduty.Inputs.ResponsePlayResponderEscalationRuleTargetArgs
                        {
                            Id = "string",
                            Type = "string",
                        },
                    },
                    EscalationDelayInMinutes = 0,
                    Id = "string",
                },
            },
            Id = "string",
            Name = "string",
            NumLoops = 0,
            OnCallHandoffNotifications = "string",
            Services = new[]
            {
                new Pagerduty.Inputs.ResponsePlayResponderServiceArgs
                {
                    Id = "string",
                    Type = "string",
                },
            },
            Teams = new[]
            {
                new Pagerduty.Inputs.ResponsePlayResponderTeamArgs
                {
                    Type = "string",
                    Id = "string",
                },
            },
            Type = "string",
        },
    },
    RespondersMessage = "string",
    Runnability = "string",
    Subscribers = new[]
    {
        new Pagerduty.Inputs.ResponsePlaySubscriberArgs
        {
            Id = "string",
            Type = "string",
        },
    },
    SubscribersMessage = "string",
    Team = "string",
    Type = "string",
});

    example, err := pagerduty.NewResponsePlay(ctx, "responsePlayResource", &pagerduty.ResponsePlayArgs{
	From:             pulumi.String("string"),
	ConferenceNumber: pulumi.String("string"),
	ConferenceUrl:    pulumi.String("string"),
	Description:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	Responders: pagerduty.ResponsePlayResponderArray{
		&pagerduty.ResponsePlayResponderArgs{
			Description: pulumi.String("string"),
			EscalationRules: pagerduty.ResponsePlayResponderEscalationRuleArray{
				&pagerduty.ResponsePlayResponderEscalationRuleArgs{
					Targets: pagerduty.ResponsePlayResponderEscalationRuleTargetArray{
						&pagerduty.ResponsePlayResponderEscalationRuleTargetArgs{
							Id:   pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					EscalationDelayInMinutes: pulumi.Int(0),
					Id:                       pulumi.String("string"),
				},
			},
			Id:                         pulumi.String("string"),
			Name:                       pulumi.String("string"),
			NumLoops:                   pulumi.Int(0),
			OnCallHandoffNotifications: pulumi.String("string"),
			Services: pagerduty.ResponsePlayResponderServiceArray{
				&pagerduty.ResponsePlayResponderServiceArgs{
					Id:   pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			Teams: pagerduty.ResponsePlayResponderTeamArray{
				&pagerduty.ResponsePlayResponderTeamArgs{
					Type: pulumi.String("string"),
					Id:   pulumi.String("string"),
				},
			},
			Type: pulumi.String("string"),
		},
	},
	RespondersMessage: pulumi.String("string"),
	Runnability:       pulumi.String("string"),
	Subscribers: pagerduty.ResponsePlaySubscriberArray{
		&pagerduty.ResponsePlaySubscriberArgs{
			Id:   pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	SubscribersMessage: pulumi.String("string"),
	Team:               pulumi.String("string"),
	Type:               pulumi.String("string"),
})

    var responsePlayResource = new ResponsePlay("responsePlayResource", ResponsePlayArgs.builder()
    .from("string")
    .conferenceNumber("string")
    .conferenceUrl("string")
    .description("string")
    .name("string")
    .responders(ResponsePlayResponderArgs.builder()
        .description("string")
        .escalationRules(ResponsePlayResponderEscalationRuleArgs.builder()
            .targets(ResponsePlayResponderEscalationRuleTargetArgs.builder()
                .id("string")
                .type("string")
                .build())
            .escalationDelayInMinutes(0)
            .id("string")
            .build())
        .id("string")
        .name("string")
        .numLoops(0)
        .onCallHandoffNotifications("string")
        .services(ResponsePlayResponderServiceArgs.builder()
            .id("string")
            .type("string")
            .build())
        .teams(ResponsePlayResponderTeamArgs.builder()
            .type("string")
            .id("string")
            .build())
        .type("string")
        .build())
    .respondersMessage("string")
    .runnability("string")
    .subscribers(ResponsePlaySubscriberArgs.builder()
        .id("string")
        .type("string")
        .build())
    .subscribersMessage("string")
    .team("string")
    .type("string")
    .build());

    response_play_resource = pagerduty.ResponsePlay("responsePlayResource",
    from_="string",
    conference_number="string",
    conference_url="string",
    description="string",
    name="string",
    responders=[{
        "description": "string",
        "escalation_rules": [{
            "targets": [{
                "id": "string",
                "type": "string",
            }],
            "escalation_delay_in_minutes": 0,
            "id": "string",
        }],
        "id": "string",
        "name": "string",
        "num_loops": 0,
        "on_call_handoff_notifications": "string",
        "services": [{
            "id": "string",
            "type": "string",
        }],
        "teams": [{
            "type": "string",
            "id": "string",
        }],
        "type": "string",
    }],
    responders_message="string",
    runnability="string",
    subscribers=[{
        "id": "string",
        "type": "string",
    }],
    subscribers_message="string",
    team="string",
    type="string")

    const responsePlayResource = new pagerduty.ResponsePlay("responsePlayResource", {
    from: "string",
    conferenceNumber: "string",
    conferenceUrl: "string",
    description: "string",
    name: "string",
    responders: [{
        description: "string",
        escalationRules: [{
            targets: [{
                id: "string",
                type: "string",
            }],
            escalationDelayInMinutes: 0,
            id: "string",
        }],
        id: "string",
        name: "string",
        numLoops: 0,
        onCallHandoffNotifications: "string",
        services: [{
            id: "string",
            type: "string",
        }],
        teams: [{
            type: "string",
            id: "string",
        }],
        type: "string",
    }],
    respondersMessage: "string",
    runnability: "string",
    subscribers: [{
        id: "string",
        type: "string",
    }],
    subscribersMessage: "string",
    team: "string",
    type: "string",
});

    type: pagerduty:ResponsePlay
properties:
    conferenceNumber: string
    conferenceUrl: string
    description: string
    from: string
    name: string
    responders:
        - description: string
          escalationRules:
            - escalationDelayInMinutes: 0
              id: string
              targets:
                - id: string
                  type: string
          id: string
          name: string
          numLoops: 0
          onCallHandoffNotifications: string
          services:
            - id: string
              type: string
          teams:
            - id: string
              type: string
          type: string
    respondersMessage: string
    runnability: string
    subscribers:
        - id: string
          type: string
    subscribersMessage: string
    team: string
    type: string

    ResponsePlay 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 ResponsePlay resource accepts the following input properties:

    From string
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    ConferenceNumber string
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    ConferenceUrl string
    The URL that will be set as the conference URL for any incident on which this response play is run.
    Description string
    Name string
    The name of the response play.
    Responders List<ResponsePlayResponder>
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    RespondersMessage string
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    Runnability string
    String representing how this response play is allowed to be run. Valid options are:
    Subscribers List<ResponsePlaySubscriber>
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    SubscribersMessage string
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    Team string
    The ID of the team associated with the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    From string
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    ConferenceNumber string
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    ConferenceUrl string
    The URL that will be set as the conference URL for any incident on which this response play is run.
    Description string
    Name string
    The name of the response play.
    Responders []ResponsePlayResponderArgs
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    RespondersMessage string
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    Runnability string
    String representing how this response play is allowed to be run. Valid options are:
    Subscribers []ResponsePlaySubscriberArgs
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    SubscribersMessage string
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    Team string
    The ID of the team associated with the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    from String
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    conferenceNumber String
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conferenceUrl String
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description String
    name String
    The name of the response play.
    responders List<ResponsePlayResponder>
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    respondersMessage String
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability String
    String representing how this response play is allowed to be run. Valid options are:
    subscribers List<ResponsePlaySubscriber>
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribersMessage String
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team String
    The ID of the team associated with the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".
    from string
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    conferenceNumber string
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conferenceUrl string
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description string
    name string
    The name of the response play.
    responders ResponsePlayResponder[]
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    respondersMessage string
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability string
    String representing how this response play is allowed to be run. Valid options are:
    subscribers ResponsePlaySubscriber[]
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribersMessage string
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team string
    The ID of the team associated with the response play.
    type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    from_ str
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    conference_number str
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conference_url str
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description str
    name str
    The name of the response play.
    responders Sequence[ResponsePlayResponderArgs]
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    responders_message str
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability str
    String representing how this response play is allowed to be run. Valid options are:
    subscribers Sequence[ResponsePlaySubscriberArgs]
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribers_message str
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team str
    The ID of the team associated with the response play.
    type str
    A string that determines the schema of the object. If not set, the default value is "response_play".
    from String
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    conferenceNumber String
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conferenceUrl String
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description String
    name String
    The name of the response play.
    responders List<Property Map>
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    respondersMessage String
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability String
    String representing how this response play is allowed to be run. Valid options are:
    subscribers List<Property Map>
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribersMessage String
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team String
    The ID of the team associated with the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ResponsePlay 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 ResponsePlay Resource

    Get an existing ResponsePlay 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?: ResponsePlayState, opts?: CustomResourceOptions): ResponsePlay
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        conference_number: Optional[str] = None,
        conference_url: Optional[str] = None,
        description: Optional[str] = None,
        from_: Optional[str] = None,
        name: Optional[str] = None,
        responders: Optional[Sequence[ResponsePlayResponderArgs]] = None,
        responders_message: Optional[str] = None,
        runnability: Optional[str] = None,
        subscribers: Optional[Sequence[ResponsePlaySubscriberArgs]] = None,
        subscribers_message: Optional[str] = None,
        team: Optional[str] = None,
        type: Optional[str] = None) -> ResponsePlay
    func GetResponsePlay(ctx *Context, name string, id IDInput, state *ResponsePlayState, opts ...ResourceOption) (*ResponsePlay, error)
    public static ResponsePlay Get(string name, Input<string> id, ResponsePlayState? state, CustomResourceOptions? opts = null)
    public static ResponsePlay get(String name, Output<String> id, ResponsePlayState 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:
    ConferenceNumber string
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    ConferenceUrl string
    The URL that will be set as the conference URL for any incident on which this response play is run.
    Description string
    From string
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    Name string
    The name of the response play.
    Responders List<ResponsePlayResponder>
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    RespondersMessage string
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    Runnability string
    String representing how this response play is allowed to be run. Valid options are:
    Subscribers List<ResponsePlaySubscriber>
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    SubscribersMessage string
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    Team string
    The ID of the team associated with the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    ConferenceNumber string
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    ConferenceUrl string
    The URL that will be set as the conference URL for any incident on which this response play is run.
    Description string
    From string
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    Name string
    The name of the response play.
    Responders []ResponsePlayResponderArgs
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    RespondersMessage string
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    Runnability string
    String representing how this response play is allowed to be run. Valid options are:
    Subscribers []ResponsePlaySubscriberArgs
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    SubscribersMessage string
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    Team string
    The ID of the team associated with the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    conferenceNumber String
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conferenceUrl String
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description String
    from String
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    name String
    The name of the response play.
    responders List<ResponsePlayResponder>
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    respondersMessage String
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability String
    String representing how this response play is allowed to be run. Valid options are:
    subscribers List<ResponsePlaySubscriber>
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribersMessage String
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team String
    The ID of the team associated with the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".
    conferenceNumber string
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conferenceUrl string
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description string
    from string
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    name string
    The name of the response play.
    responders ResponsePlayResponder[]
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    respondersMessage string
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability string
    String representing how this response play is allowed to be run. Valid options are:
    subscribers ResponsePlaySubscriber[]
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribersMessage string
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team string
    The ID of the team associated with the response play.
    type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    conference_number str
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conference_url str
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description str
    from_ str
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    name str
    The name of the response play.
    responders Sequence[ResponsePlayResponderArgs]
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    responders_message str
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability str
    String representing how this response play is allowed to be run. Valid options are:
    subscribers Sequence[ResponsePlaySubscriberArgs]
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribers_message str
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team str
    The ID of the team associated with the response play.
    type str
    A string that determines the schema of the object. If not set, the default value is "response_play".
    conferenceNumber String
    The telephone number that will be set as the conference number for any incident on which this response play is run.
    conferenceUrl String
    The URL that will be set as the conference URL for any incident on which this response play is run.
    description String
    from String
    The email of the user attributed to the request. Needs to be a valid email address of a user in the PagerDuty account.
    name String
    The name of the response play.
    responders List<Property Map>
    A user and/or escalation policy to be requested as a responder to any incident on which this response play is run. There can be multiple responders defined on a single response play.
    respondersMessage String
    The message body of the notification that will be sent to this response play's set of responders. If empty, a default response request notification will be sent.
    runnability String
    String representing how this response play is allowed to be run. Valid options are:
    subscribers List<Property Map>
    A user and/or team to be added as a subscriber to any incident on which this response play is run. There can be multiple subscribers defined on a single response play.
    subscribersMessage String
    The content of the notification that will be sent to all incident subscribers upon the running of this response play. Note that this includes any users who may have already been subscribed to the incident prior to the running of this response play. If empty, no notifications will be sent.
    team String
    The ID of the team associated with the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".

    Supporting Types

    ResponsePlayResponder, ResponsePlayResponderArgs

    Description string
    Description of escalation policy
    EscalationRules List<ResponsePlayResponderEscalationRule>
    The escalation rules
    Id string
    ID of the user defined as the responder
    Name string
    Name of the escalation policy
    NumLoops int
    The number of times the escalation policy will repeat after reaching the end of its escalation.
    OnCallHandoffNotifications string
    Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". Could be "if_has_services", "always
    Services List<ResponsePlayResponderService>
    There can be multiple services associated with a policy.
    Teams List<ResponsePlayResponderTeam>
    Teams associated with the policy. Account must have the teams ability to use this parameter. There can be multiple teams associated with a policy.
    Type string
    Should be set as escalation_policy for escalation policy responders.
    Description string
    Description of escalation policy
    EscalationRules []ResponsePlayResponderEscalationRule
    The escalation rules
    Id string
    ID of the user defined as the responder
    Name string
    Name of the escalation policy
    NumLoops int
    The number of times the escalation policy will repeat after reaching the end of its escalation.
    OnCallHandoffNotifications string
    Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". Could be "if_has_services", "always
    Services []ResponsePlayResponderService
    There can be multiple services associated with a policy.
    Teams []ResponsePlayResponderTeam
    Teams associated with the policy. Account must have the teams ability to use this parameter. There can be multiple teams associated with a policy.
    Type string
    Should be set as escalation_policy for escalation policy responders.
    description String
    Description of escalation policy
    escalationRules List<ResponsePlayResponderEscalationRule>
    The escalation rules
    id String
    ID of the user defined as the responder
    name String
    Name of the escalation policy
    numLoops Integer
    The number of times the escalation policy will repeat after reaching the end of its escalation.
    onCallHandoffNotifications String
    Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". Could be "if_has_services", "always
    services List<ResponsePlayResponderService>
    There can be multiple services associated with a policy.
    teams List<ResponsePlayResponderTeam>
    Teams associated with the policy. Account must have the teams ability to use this parameter. There can be multiple teams associated with a policy.
    type String
    Should be set as escalation_policy for escalation policy responders.
    description string
    Description of escalation policy
    escalationRules ResponsePlayResponderEscalationRule[]
    The escalation rules
    id string
    ID of the user defined as the responder
    name string
    Name of the escalation policy
    numLoops number
    The number of times the escalation policy will repeat after reaching the end of its escalation.
    onCallHandoffNotifications string
    Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". Could be "if_has_services", "always
    services ResponsePlayResponderService[]
    There can be multiple services associated with a policy.
    teams ResponsePlayResponderTeam[]
    Teams associated with the policy. Account must have the teams ability to use this parameter. There can be multiple teams associated with a policy.
    type string
    Should be set as escalation_policy for escalation policy responders.
    description str
    Description of escalation policy
    escalation_rules Sequence[ResponsePlayResponderEscalationRule]
    The escalation rules
    id str
    ID of the user defined as the responder
    name str
    Name of the escalation policy
    num_loops int
    The number of times the escalation policy will repeat after reaching the end of its escalation.
    on_call_handoff_notifications str
    Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". Could be "if_has_services", "always
    services Sequence[ResponsePlayResponderService]
    There can be multiple services associated with a policy.
    teams Sequence[ResponsePlayResponderTeam]
    Teams associated with the policy. Account must have the teams ability to use this parameter. There can be multiple teams associated with a policy.
    type str
    Should be set as escalation_policy for escalation policy responders.
    description String
    Description of escalation policy
    escalationRules List<Property Map>
    The escalation rules
    id String
    ID of the user defined as the responder
    name String
    Name of the escalation policy
    numLoops Number
    The number of times the escalation policy will repeat after reaching the end of its escalation.
    onCallHandoffNotifications String
    Determines how on call handoff notifications will be sent for users on the escalation policy. Defaults to "if_has_services". Could be "if_has_services", "always
    services List<Property Map>
    There can be multiple services associated with a policy.
    teams List<Property Map>
    Teams associated with the policy. Account must have the teams ability to use this parameter. There can be multiple teams associated with a policy.
    type String
    Should be set as escalation_policy for escalation policy responders.

    ResponsePlayResponderEscalationRule, ResponsePlayResponderEscalationRuleArgs

    Targets List<ResponsePlayResponderEscalationRuleTarget>
    The targets an incident should be assigned to upon reaching this rule.
    EscalationDelayInMinutes int
    The number of minutes before an unacknowledged incident escalates away from this rule.
    Id string
    The ID of the response play.
    Targets []ResponsePlayResponderEscalationRuleTarget
    The targets an incident should be assigned to upon reaching this rule.
    EscalationDelayInMinutes int
    The number of minutes before an unacknowledged incident escalates away from this rule.
    Id string
    The ID of the response play.
    targets List<ResponsePlayResponderEscalationRuleTarget>
    The targets an incident should be assigned to upon reaching this rule.
    escalationDelayInMinutes Integer
    The number of minutes before an unacknowledged incident escalates away from this rule.
    id String
    The ID of the response play.
    targets ResponsePlayResponderEscalationRuleTarget[]
    The targets an incident should be assigned to upon reaching this rule.
    escalationDelayInMinutes number
    The number of minutes before an unacknowledged incident escalates away from this rule.
    id string
    The ID of the response play.
    targets Sequence[ResponsePlayResponderEscalationRuleTarget]
    The targets an incident should be assigned to upon reaching this rule.
    escalation_delay_in_minutes int
    The number of minutes before an unacknowledged incident escalates away from this rule.
    id str
    The ID of the response play.
    targets List<Property Map>
    The targets an incident should be assigned to upon reaching this rule.
    escalationDelayInMinutes Number
    The number of minutes before an unacknowledged incident escalates away from this rule.
    id String
    The ID of the response play.

    ResponsePlayResponderEscalationRuleTarget, ResponsePlayResponderEscalationRuleTargetArgs

    Id string
    The ID of the response play.
    Type string
    Type of object of the target. Supported types are user_reference, schedule_reference.
    Id string
    The ID of the response play.
    Type string
    Type of object of the target. Supported types are user_reference, schedule_reference.
    id String
    The ID of the response play.
    type String
    Type of object of the target. Supported types are user_reference, schedule_reference.
    id string
    The ID of the response play.
    type string
    Type of object of the target. Supported types are user_reference, schedule_reference.
    id str
    The ID of the response play.
    type str
    Type of object of the target. Supported types are user_reference, schedule_reference.
    id String
    The ID of the response play.
    type String
    Type of object of the target. Supported types are user_reference, schedule_reference.

    ResponsePlayResponderService, ResponsePlayResponderServiceArgs

    Id string
    The ID of the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    Id string
    The ID of the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id String
    The ID of the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id string
    The ID of the response play.
    type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id str
    The ID of the response play.
    type str
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id String
    The ID of the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".

    ResponsePlayResponderTeam, ResponsePlayResponderTeamArgs

    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    Id string
    The ID of the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    Id string
    The ID of the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id String
    The ID of the response play.
    type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id string
    The ID of the response play.
    type str
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id str
    The ID of the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id String
    The ID of the response play.

    ResponsePlaySubscriber, ResponsePlaySubscriberArgs

    Id string
    The ID of the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    Id string
    The ID of the response play.
    Type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id String
    The ID of the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id string
    The ID of the response play.
    type string
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id str
    The ID of the response play.
    type str
    A string that determines the schema of the object. If not set, the default value is "response_play".
    id String
    The ID of the response play.
    type String
    A string that determines the schema of the object. If not set, the default value is "response_play".

    Import

    Response Plays can be imported using the id.from(email), e.g.

    $ pulumi import pagerduty:index/responsePlay:ResponsePlay main 16208303-022b-f745-f2f5-560e537a2a74.user@email.com

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

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.17.0 published on Wednesday, Nov 20, 2024 by Pulumi
    pulumi/pulumi-pagerduty