1. Docs
  2. Reference
  3. API
  4. @pulumi/pagerduty

Package @pulumi/pagerduty

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-pagerduty repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-pagerduty repo.

var pagerduty = require("@pulumi/pagerduty");

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

Modules

Resources

Functions

Others

Resources

Resource Addon

class Addon extends CustomResource

With add-ons, third-party developers can write their own add-ons to PagerDuty’s UI. Given a configuration containing a src parameter, that URL will be embedded in an iframe on a page that’s available to users from a drop-down menu.

Example Usage

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

const example = new pagerduty.Addon("example", {
    src: "https://intranet.example.com/status",
});

constructor

new Addon(name: string, args: AddonArgs, opts?: pulumi.CustomResourceOptions)

Create a Addon resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AddonState, opts?: pulumi.CustomResourceOptions): Addon

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Addon

Returns true if the given object is an instance of Addon. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the add-on.

property src

public src: pulumi.Output<string>;

The source URL to display in a frame in the PagerDuty UI. HTTPS is required.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource BusinessService

class BusinessService extends CustomResource

A business service allows you to model capabilities that span multiple technical services and that may be owned by several different teams.

Example Usage

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

const example = new pagerduty.BusinessService("example", {
    description: "A very descriptive description of this business service",
    pointOfContact: "PagerDuty Admin",
});

constructor

new BusinessService(name: string, args?: BusinessServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a BusinessService resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BusinessServiceState, opts?: pulumi.CustomResourceOptions): BusinessService

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BusinessService

Returns true if the given object is an instance of BusinessService. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

property htmlUrl

public htmlUrl: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the business service.

property pointOfContact

public pointOfContact: pulumi.Output<string | undefined>;

The owner of the business service.

property self

public self: pulumi.Output<string>;

property summary

public summary: pulumi.Output<string>;

property type

public type: pulumi.Output<string | undefined>;

Default value is businessService. Can also be set as businessServiceReference.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EscalationPolicy

class EscalationPolicy extends CustomResource

An escalation policy determines what user or schedule will be notified first, second, and so on when an incident is triggered. Escalation policies are used by one or more services.

Example Usage

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

const exampleTeam = new pagerduty.Team("example", {
    description: "All engineering",
});
const exampleUser = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
    teams: [exampleTeam.id],
});
const exampleEscalationPolicy = new pagerduty.EscalationPolicy("example", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: exampleUser.id,
            type: "user",
        }],
    }],
    teams: [exampleTeam.id],
});

constructor

new EscalationPolicy(name: string, args: EscalationPolicyArgs, opts?: pulumi.CustomResourceOptions)

Create a EscalationPolicy resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EscalationPolicyState, opts?: pulumi.CustomResourceOptions): EscalationPolicy

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EscalationPolicy

Returns true if the given object is an instance of EscalationPolicy. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the escalation policy.

property numLoops

public numLoops: pulumi.Output<number | undefined>;

The number of times the escalation policy will repeat after reaching the end of its escalation.

property rules

public rules: pulumi.Output<EscalationPolicyRule[]>;

An Escalation rule block. Escalation rules documented below.

property teams

public teams: pulumi.Output<string[] | undefined>;

Teams associated with the policy. Account must have the teams ability to use this parameter.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EventRule

class EventRule extends CustomResource

constructor

new EventRule(name: string, args: EventRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a EventRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventRuleState, opts?: pulumi.CustomResourceOptions): EventRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventRule

Returns true if the given object is an instance of EventRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property actionJson

public actionJson: pulumi.Output<string>;

A list of one or more actions for each rule. Each action within the list is itself a list.

property advancedConditionJson

public advancedConditionJson: pulumi.Output<string | undefined>;

Contains a list of specific conditions including active-between,scheduled-weekly, and frequency-over. The first element in the list is the label for the condition, followed by a list of values for the specific condition. For more details on these conditions see Advanced Condition in the PagerDuty API documentation.

property catchAll

public catchAll: pulumi.Output<boolean>;

A boolean that indicates whether the rule is a catch all for the account. This field is read-only through the PagerDuty API.

property conditionJson

public conditionJson: pulumi.Output<string>;

Contains a list of conditions. The first field in the list is and or or, followed by a list of operators and values.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Extension

class Extension extends CustomResource

An extension can be associated with a service.

Example Usage

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

const webhook = pulumi.output(pagerduty.getExtensionSchema({
    name: "Generic V2 Webhook",
}, { async: true }));
const exampleUser = new pagerduty.User("example", {
    email: "howard.james@example.domain",
    teams: [pagerduty_team_example.id],
});
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: exampleUser.id,
            type: "user",
        }],
    }],
});
const exampleService = new pagerduty.Service("example", {
    acknowledgementTimeout: "600",
    autoResolveTimeout: "14400",
    escalationPolicy: pagerduty_escalation_policy_example.id,
});
const slack = new pagerduty.Extension("slack", {
    config: `{
	"restrict": "any",
	"notifyTypes": {
			"resolve": false,
			"acknowledge": false,
			"assignments": false
	},
	"accessToken": "XXX"
}
`,
    endpointUrl: "https://generic_webhook_url/XXXXXX/BBBBBB",
    extensionObjects: [exampleService.id],
    extensionSchema: webhook.id,
});

constructor

new Extension(name: string, args: ExtensionArgs, opts?: pulumi.CustomResourceOptions)

Create a Extension resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ExtensionState, opts?: pulumi.CustomResourceOptions): Extension

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Extension

Returns true if the given object is an instance of Extension. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property config

public config: pulumi.Output<string | undefined>;

The configuration of the service extension as string containing plain JSON-encoded data.

property endpointUrl

public endpointUrl: pulumi.Output<string | undefined>;

The url of the extension. Note: The endpoint URL is Optional API wise in most cases. But in some cases it is a Required parameter. For example, pagerduty..getExtensionSchema named Generic V2 Webhook doesn’t accept pagerduty..Extension with no endpointUrl, but one with named Slack accepts.

property extensionObjects

public extensionObjects: pulumi.Output<string[]>;

This is the objects for which the extension applies (An array of service ids).

property extensionSchema

public extensionSchema: pulumi.Output<string>;

This is the schema for this extension.

property htmlUrl

public htmlUrl: pulumi.Output<string>;

URL at which the entity is uniquely displayed in the Web app

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the service extension.

property type

public type: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource MaintenanceWindow

class MaintenanceWindow extends CustomResource

A maintenance window is used to temporarily disable one or more services for a set period of time. No incidents will be triggered and no notifications will be received while a service is disabled by a maintenance window.

Maintenance windows are specified to start at a certain time and end after they have begun. Once started, a maintenance window cannot be deleted; it can only be ended immediately to re-enable the service.

Example Usage

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

const example = new pagerduty.MaintenanceWindow("example", {
    endTime: "2015-11-09T22:00:00-05:00",
    services: [pagerduty_service_example.id],
    startTime: "2015-11-09T20:00:00-05:00",
});

constructor

new MaintenanceWindow(name: string, args: MaintenanceWindowArgs, opts?: pulumi.CustomResourceOptions)

Create a MaintenanceWindow resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: MaintenanceWindowState, opts?: pulumi.CustomResourceOptions): MaintenanceWindow

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is MaintenanceWindow

Returns true if the given object is an instance of MaintenanceWindow. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

A description for the maintenance window.

property endTime

public endTime: pulumi.Output<string>;

The maintenance window’s end time. This is when the services will start creating incidents again. This date must be in the future and after the startTime.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property services

public services: pulumi.Output<string[]>;

A list of service IDs to include in the maintenance window.

property startTime

public startTime: pulumi.Output<string>;

The maintenance window’s start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Provider

class Provider extends ProviderResource

The provider type for the pagerduty package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

constructor

new Provider(name: string, args?: ProviderArgs, opts?: pulumi.ResourceOptions)

Create a Provider resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Provider

Returns true if the given object is an instance of Provider. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

method register

static register(provider: ProviderResource | undefined): Promise<string | undefined>

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Ruleset

class Ruleset extends CustomResource

Rulesets allow you to route events to an endpoint and create collections of event rules, which define sets of actions to take based on event content.

Example Usage

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

const fooTeam = new pagerduty.Team("fooTeam", {});
const fooRuleset = new pagerduty.Ruleset("fooRuleset", {team: {
    id: fooTeam.id,
}});

constructor

new Ruleset(name: string, args?: RulesetArgs, opts?: pulumi.CustomResourceOptions)

Create a Ruleset resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RulesetState, opts?: pulumi.CustomResourceOptions): Ruleset

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Ruleset

Returns true if the given object is an instance of Ruleset. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Name of the ruleset.

property routingKeys

public routingKeys: pulumi.Output<string[]>;

Routing keys routed to this ruleset.

property team

public team: pulumi.Output<RulesetTeam | undefined>;

Reference to the team that owns the ruleset. If none is specified, only admins have access.

property type

public type: pulumi.Output<string>;

Type of ruleset. Currently only sets to global.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RulesetRule

class RulesetRule extends CustomResource

constructor

new RulesetRule(name: string, args: RulesetRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a RulesetRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RulesetRuleState, opts?: pulumi.CustomResourceOptions): RulesetRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RulesetRule

Returns true if the given object is an instance of RulesetRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property actions

public actions: pulumi.Output<RulesetRuleActions | undefined>;

Actions to apply to an event if the conditions match.

property conditions

public conditions: pulumi.Output<RulesetRuleConditions | undefined>;

Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.

property disabled

public disabled: pulumi.Output<boolean | undefined>;

Indicates whether the rule is disabled and would therefore not be evaluated.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property position

public position: pulumi.Output<number | undefined>;

Position/index of the rule within the ruleset.

property ruleset

public ruleset: pulumi.Output<string>;

The ID of the ruleset that the rule belongs to.

property timeFrame

public timeFrame: pulumi.Output<RulesetRuleTimeFrame | undefined>;

Settings for scheduling the rule.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Schedule

class Schedule extends CustomResource

A schedule determines the time periods that users are on call. Only on-call users are eligible to receive notifications from incidents.

Example Usage

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

const example = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
    teams: [pagerduty_team_example.id],
});
const foo = new pagerduty.Schedule("foo", {
    layers: [{
        name: "Night Shift",
        restrictions: [{
            durationSeconds: 32400,
            startTimeOfDay: "08:00:00",
            type: "dailyRestriction",
        }],
        rotationTurnLengthSeconds: 86400,
        rotationVirtualStart: "2015-11-06T20:00:00-05:00",
        start: "2015-11-06T20:00:00-05:00",
        users: [pagerduty_user_foo.id],
    }],
    timeZone: "America/New_York",
});

constructor

new Schedule(name: string, args: ScheduleArgs, opts?: pulumi.CustomResourceOptions)

Create a Schedule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ScheduleState, opts?: pulumi.CustomResourceOptions): Schedule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Schedule

Returns true if the given object is an instance of Schedule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the schedule

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property layers

public layers: pulumi.Output<ScheduleLayer[]>;

A schedule layer block. Schedule layers documented below.

property name

public name: pulumi.Output<string>;

The name of the schedule.

property overflow

public overflow: pulumi.Output<boolean | undefined>;

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow is passed. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: If you don’t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. If you do pass the overflow parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

property timeZone

public timeZone: pulumi.Output<string>;

The time zone of the schedule (e.g Europe/Berlin).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

A service represents something you monitor (like a web service, email service, or database service). It is a container for related incidents that associates them with escalation policies.

Example Usage

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

const exampleUser = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
    teams: [pagerduty_team_example.id],
});
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: exampleUser.id,
            type: "user",
        }],
    }],
});
const exampleService = new pagerduty.Service("example", {
    acknowledgementTimeout: "600",
    alertCreation: "createIncidents",
    autoResolveTimeout: "14400",
    escalationPolicy: pagerduty_escalation_policy_example.id,
});

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Service

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property acknowledgementTimeout

public acknowledgementTimeout: pulumi.Output<string | undefined>;

Time in seconds that an incident changes to the Triggered State after being Acknowledged. Disabled if set to the "null" string.

property alertCreation

public alertCreation: pulumi.Output<string | undefined>;

Must be one of two values. PagerDuty receives events from your monitoring systems and can then create incidents in different ways. Value “createIncidents” is default: events will create an incident that cannot be merged. Value “createAlertsAndIncidents” is the alternative: events will create an alert and then add it to a new incident, these incidents can be merged.

property alertGrouping

public alertGrouping: pulumi.Output<string | undefined>;

Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. If not set, each alert will create a separate incident; If value is set to time: All alerts within a specified duration will be grouped into the same incident. This duration is set in the alertGroupingTimeout setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; If value is set to intelligent - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plan.

property alertGroupingTimeout

public alertGroupingTimeout: pulumi.Output<number | undefined>;

The duration in minutes within which to automatically group incoming alerts. This setting applies only when alertGrouping is set to time. To continue grouping alerts until the incident is resolved, set this value to 0.

property autoResolveTimeout

public autoResolveTimeout: pulumi.Output<string | undefined>;

Time in seconds that an incident is automatically resolved if left open for that long. Disabled if set to the "null" string.

property createdAt

public createdAt: pulumi.Output<string>;

property description

public description: pulumi.Output<string | undefined>;

property escalationPolicy

public escalationPolicy: pulumi.Output<string>;

The escalation policy used by this service.

property htmlUrl

public htmlUrl: pulumi.Output<string>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property incidentUrgencyRule

public incidentUrgencyRule: pulumi.Output<ServiceIncidentUrgencyRule>;

property lastIncidentTimestamp

public lastIncidentTimestamp: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the service.

property scheduledActions

public scheduledActions: pulumi.Output<ServiceScheduledAction[] | undefined>;

property status

public status: pulumi.Output<string>;

property supportHours

public supportHours: pulumi.Output<ServiceSupportHours | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceDependency

class ServiceDependency extends CustomResource

A service dependency is a relationship between a business service and technical and business services that this service uses, or that are used by this service, and are critical for successful operation.

Example Usage

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

const foo = new pagerduty.ServiceDependency("foo", {dependency: [{
    dependent_service: [{
        id: pagerduty_business_service.foo.id,
        type: "businessService",
    }],
    supporting_service: [{
        id: pagerduty_service.foo.id,
        type: "service",
    }],
}]});
const bar = new pagerduty.ServiceDependency("bar", {dependency: [{
    dependent_service: [{
        id: pagerduty_business_service.foo.id,
        type: "businessService",
    }],
    supporting_service: [{
        id: pagerduty_service.two.id,
        type: "service",
    }],
}]});

constructor

new ServiceDependency(name: string, args: ServiceDependencyArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceDependency resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceDependencyState, opts?: pulumi.CustomResourceOptions): ServiceDependency

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceDependency

Returns true if the given object is an instance of ServiceDependency. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dependencies

public dependencies: pulumi.Output<ServiceDependencyDependency[]>;

The relationship between the supportingService and dependentService.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ServiceIntegration

class ServiceIntegration extends CustomResource

A service integration is an integration that belongs to a service.

Example Usage

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

const exampleUser = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
    teams: [pagerduty_team_example.id],
});
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: exampleUser.id,
            type: "user",
        }],
    }],
});
const exampleService = new pagerduty.Service("example", {
    acknowledgementTimeout: "600",
    autoResolveTimeout: "14400",
    escalationPolicy: pagerduty_escalation_policy_example.id,
});
const exampleServiceIntegration = new pagerduty.ServiceIntegration("example", {
    service: exampleService.id,
    type: "genericEventsApiInboundIntegration",
});
const datadogVendor = pulumi.output(pagerduty.getVendor({
    name: "Datadog",
}, { async: true }));
const datadogServiceIntegration = new pagerduty.ServiceIntegration("datadog", {
    service: exampleService.id,
    vendor: datadogVendor.id,
});
const cloudwatchVendor = pulumi.output(pagerduty.getVendor({
    name: "Cloudwatch",
}, { async: true }));
const cloudwatchServiceIntegration = new pagerduty.ServiceIntegration("cloudwatch", {
    service: exampleService.id,
    vendor: cloudwatchVendor.id,
});

constructor

new ServiceIntegration(name: string, args: ServiceIntegrationArgs, opts?: pulumi.CustomResourceOptions)

Create a ServiceIntegration resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceIntegrationState, opts?: pulumi.CustomResourceOptions): ServiceIntegration

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ServiceIntegration

Returns true if the given object is an instance of ServiceIntegration. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property htmlUrl

public htmlUrl: pulumi.Output<string>;

URL at which the entity is uniquely displayed in the Web app

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property integrationEmail

public integrationEmail: pulumi.Output<string>;

This is the unique fully-qualified email address used for routing emails to this integration for processing.

property integrationKey

public integrationKey: pulumi.Output<string>;

This is the unique key used to route events to this integration when received via the PagerDuty Events API.

property name

public name: pulumi.Output<string>;

The name of the service integration.

property service

public service: pulumi.Output<string>;

The ID of the service the integration should belong to.

property type

public type: pulumi.Output<string>;

The service type. Can be: awsCloudwatchInboundIntegration, cloudkickInboundIntegration, eventTransformerApiInboundIntegration, eventsApiV2InboundIntegration (requires service alertCreation to be createAlertsAndIncidents), genericEmailInboundIntegration, genericEventsApiInboundIntegration, keynoteInboundIntegration, nagiosInboundIntegration, pingdomInboundIntegrationor sqlMonitorInboundIntegration.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vendor

public vendor: pulumi.Output<string>;

The ID of the vendor the integration should integrate with (e.g Datadog or Amazon Cloudwatch).

Resource Team

class Team extends CustomResource

A team is a collection of users and escalation policies that represent a group of people within an organization.

The account must have the teams ability to use the following resource.

Example Usage

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

const example = new pagerduty.Team("example", {
    description: "All engineering",
});

constructor

new Team(name: string, args?: TeamArgs, opts?: pulumi.CustomResourceOptions)

Create a Team resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TeamState, opts?: pulumi.CustomResourceOptions): Team

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Team

Returns true if the given object is an instance of Team. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

property htmlUrl

public htmlUrl: pulumi.Output<string>;

URL at which the entity is uniquely displayed in the Web app

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the group.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TeamMembership

class TeamMembership extends CustomResource

A team membership manages memberships within a team.

Example Usage

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

const fooUser = new pagerduty.User("foo", {
    email: "foo@bar.com",
});
const fooTeam = new pagerduty.Team("foo", {
    description: "foo",
});
const fooTeamMembership = new pagerduty.TeamMembership("foo", {
    role: "manager",
    teamId: fooTeam.id,
    userId: fooUser.id,
});

constructor

new TeamMembership(name: string, args: TeamMembershipArgs, opts?: pulumi.CustomResourceOptions)

Create a TeamMembership resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TeamMembershipState, opts?: pulumi.CustomResourceOptions): TeamMembership

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TeamMembership

Returns true if the given object is an instance of TeamMembership. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property role

public role: pulumi.Output<string | undefined>;

The role of the user in the team. One of observer, responder, or manager. Defaults to manager.

property teamId

public teamId: pulumi.Output<string>;

The ID of the team in which the user will belong.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

The ID of the user to add to the team.

Resource User

class User extends CustomResource

A user is a member of a PagerDuty account that have the ability to interact with incidents and other data on the account.

Example Usage

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

const example = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
});

constructor

new User(name: string, args: UserArgs, opts?: pulumi.CustomResourceOptions)

Create a User resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserState, opts?: pulumi.CustomResourceOptions): User

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is User

Returns true if the given object is an instance of User. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property avatarUrl

public avatarUrl: pulumi.Output<string>;

The URL of the user’s avatar.

property color

public color: pulumi.Output<string>;

The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.

property description

public description: pulumi.Output<string | undefined>;

property email

public email: pulumi.Output<string>;

The user’s email address.

property htmlUrl

public htmlUrl: pulumi.Output<string>;

URL at which the entity is uniquely displayed in the Web app

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property invitationSent

public invitationSent: pulumi.Output<boolean>;

If true, the user has an outstanding invitation.

property jobTitle

public jobTitle: pulumi.Output<string | undefined>;

The user’s title.

property name

public name: pulumi.Output<string>;

The name of the user.

property role

public role: pulumi.Output<string | undefined>;

The user role. Account must have the readOnlyUsers ability to set a user as a readOnlyUser. Can be admin, limitedUser, observer, owner, readOnlyUser or user

property teams

public teams: pulumi.Output<string[]>;

A list of teams the user should belong to. Please use pagerduty..TeamMembership instead.

property timeZone

public timeZone: pulumi.Output<string>;

The timezone of the user

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource UserContactMethod

class UserContactMethod extends CustomResource

A contact method is a contact method for a PagerDuty user (email, phone or SMS).

Example Usage

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

const example = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
    teams: [pagerduty_team_example.id],
});
const email = new pagerduty.UserContactMethod("email", {
    address: "foo@bar.com",
    label: "Work",
    type: "emailContactMethod",
    userId: example.id,
});
const phone = new pagerduty.UserContactMethod("phone", {
    address: "2025550199",
    countryCode: 1,
    label: "Work",
    type: "phoneContactMethod",
    userId: example.id,
});
const sms = new pagerduty.UserContactMethod("sms", {
    address: "2025550199",
    countryCode: 1,
    label: "Work",
    type: "smsContactMethod",
    userId: example.id,
});

constructor

new UserContactMethod(name: string, args: UserContactMethodArgs, opts?: pulumi.CustomResourceOptions)

Create a UserContactMethod resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserContactMethodState, opts?: pulumi.CustomResourceOptions): UserContactMethod

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is UserContactMethod

Returns true if the given object is an instance of UserContactMethod. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property address

public address: pulumi.Output<string>;

The “address” to deliver to: email, phone number, etc., depending on the type.

property blacklisted

public blacklisted: pulumi.Output<boolean>;

If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.

property countryCode

public countryCode: pulumi.Output<number | undefined>;

The 1-to-3 digit country calling code. Required when using phoneContactMethod or smsContactMethod.

property enabled

public enabled: pulumi.Output<boolean>;

If true, this phone is capable of receiving SMS messages.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property label

public label: pulumi.Output<string>;

The label (e.g., “Work”, “Mobile”, etc.).

property sendShortEmail

public sendShortEmail: pulumi.Output<boolean | undefined>;

Send an abbreviated email message instead of the standard email output.

property type

public type: pulumi.Output<string>;

The contact method type. May be (emailContactMethod, phoneContactMethod, smsContactMethod, pushNotificationContactMethod).

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

The ID of the user.

Resource UserNotificationRule

class UserNotificationRule extends CustomResource

A notification rule configures where and when a PagerDuty user is notified when a triggered incident is assigned to him. Unique notification rules can be created for both high and low-urgency incidents.

Example Usage

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

const example = new pagerduty.User("example", {email: "125.greenholt.earline@graham.name"});
const email = new pagerduty.UserContactMethod("email", {
    userId: example.id,
    type: "emailContactMethod",
    address: "foo@bar.com",
    label: "Work",
});
const phone = new pagerduty.UserContactMethod("phone", {
    userId: example.id,
    type: "phoneContactMethod",
    countryCode: "+1",
    address: "2025550199",
    label: "Work",
});
const sms = new pagerduty.UserContactMethod("sms", {
    userId: example.id,
    type: "smsContactMethod",
    countryCode: "+1",
    address: "2025550199",
    label: "Work",
});
const highUrgencyPhone = new pagerduty.UserNotificationRule("highUrgencyPhone", {
    userId: example.id,
    startDelayInMinutes: 1,
    urgency: "high",
    contactMethod: {
        type: "phoneContactMethod",
        id: phone.id,
    },
});
const lowUrgencyEmail = new pagerduty.UserNotificationRule("lowUrgencyEmail", {
    userId: example.id,
    startDelayInMinutes: 1,
    urgency: "low",
    contactMethod: {
        type: "emailContactMethod",
        id: email.id,
    },
});
const lowUrgencySms = new pagerduty.UserNotificationRule("lowUrgencySms", {
    userId: example.id,
    startDelayInMinutes: 10,
    urgency: "low",
    contactMethod: {
        type: "smsContactMethod",
        id: sms.id,
    },
});

constructor

new UserNotificationRule(name: string, args: UserNotificationRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a UserNotificationRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: UserNotificationRuleState, opts?: pulumi.CustomResourceOptions): UserNotificationRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is UserNotificationRule

Returns true if the given object is an instance of UserNotificationRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property contactMethod

public contactMethod: pulumi.Output<UserNotificationRuleContactMethod>;

A contact method block, configured as a block described below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property startDelayInMinutes

public startDelayInMinutes: pulumi.Output<number>;

The delay before firing the rule, in minutes.

property urgency

public urgency: pulumi.Output<string>;

Which incident urgency this rule is used for. Account must have the urgencies ability to have a low urgency notification rule. Can be high or low.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property userId

public userId: pulumi.Output<string>;

The ID of the user.

Functions

Function getBusinessService

getBusinessService(args: GetBusinessServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetBusinessServiceResult>

Use this data source to get information about a specific business service.

Example Usage

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

const example = pulumi.output(pagerduty.getBusinessService({
    name: "My Service",
}, { async: true }));

Function getEscalationPolicy

getEscalationPolicy(args: GetEscalationPolicyArgs, opts?: pulumi.InvokeOptions): Promise<GetEscalationPolicyResult>

Use this data source to get information about a specific escalation policy that you can use for other PagerDuty resources.

Example Usage

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

const testEscalationPolicy = pulumi.output(pagerduty.getEscalationPolicy({
    name: "Engineering Escalation Policy",
}, { async: true }));
const testService = new pagerduty.Service("test", {
    acknowledgementTimeout: "600",
    autoResolveTimeout: "14400",
    escalationPolicy: testEscalationPolicy.id,
});

Function getExtensionSchema

getExtensionSchema(args: GetExtensionSchemaArgs, opts?: pulumi.InvokeOptions): Promise<GetExtensionSchemaResult>

Use this data source to get information about a specific extension vendor that you can use for a service (e.g: Slack, Generic Webhook, ServiceNow).

Example Usage

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

const webhook = pulumi.output(pagerduty.getExtensionSchema({
    name: "Generic V2 Webhook",
}, { async: true }));
const exampleUser = new pagerduty.User("example", {
    email: "howard.james@example.domain",
    teams: [pagerduty_team_example.id],
});
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: exampleUser.id,
            type: "user",
        }],
    }],
});
const exampleService = new pagerduty.Service("example", {
    acknowledgementTimeout: "600",
    autoResolveTimeout: "14400",
    escalationPolicy: pagerduty_escalation_policy_example.id,
});
const slack = new pagerduty.Extension("slack", {
    endpointUrl: "https://generic_webhook_url/XXXXXX/BBBBBB",
    extensionObjects: [exampleService.id],
    extensionSchema: webhook.id,
});

Function getPriority

getPriority(args: GetPriorityArgs, opts?: pulumi.InvokeOptions): Promise<GetPriorityResult>

Use this data source to get information about a specific priority that you can use for other PagerDuty resources.

Example Usage

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

const p1 = pagerduty.getPriority({
    name: "P1",
});
const fooRuleset = new pagerduty.Ruleset("fooRuleset", {});
const fooRulesetRule = new pagerduty.RulesetRule("fooRulesetRule", {
    ruleset: fooRuleset.id,
    position: 0,
    disabled: "false",
    conditions: {
        operator: "and",
        subconditions: [
            {
                operator: "contains",
                parameter: [{
                    value: "disk space",
                    path: "payload.summary",
                }],
            },
            {
                operator: "contains",
                parameter: [{
                    value: "db",
                    path: "payload.source",
                }],
            },
        ],
    },
    actions: {
        route: [{
            value: "P5DTL0K",
        }],
        priority: [{
            value: pagerduty_priority.p1.id,
        }],
    },
});

Function getSchedule

getSchedule(args: GetScheduleArgs, opts?: pulumi.InvokeOptions): Promise<GetScheduleResult>

Use this data source to get information about a specific schedule that you can use for other PagerDuty resources.

Example Usage

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

const test = pulumi.output(pagerduty.getSchedule({
    name: "Daily Engineering Rotation",
}, { async: true }));
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: test.id,
            type: "schedule",
        }],
    }],
});

Function getService

getService(args: GetServiceArgs, opts?: pulumi.InvokeOptions): Promise<GetServiceResult>

Use this data source to get information about a specific service.

Example Usage

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

const exampleService = pagerduty.getService({
    name: "My Service",
});
const datadog = pagerduty.getVendor({
    name: "Datadog",
});
const exampleServiceIntegration = new pagerduty.ServiceIntegration("exampleServiceIntegration", {
    vendor: datadog.then(datadog => datadog.id),
    service: exampleService.then(exampleService => exampleService.id),
    type: "genericEventsApiInboundIntegration",
});

Function getTeam

getTeam(args: GetTeamArgs, opts?: pulumi.InvokeOptions): Promise<GetTeamResult>

Use this data source to get information about a specific team that you can use for other PagerDuty resources.

Example Usage

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

const me = pulumi.output(pagerduty.getUser({
    email: "me@example.com",
}, { async: true }));
const devops = pulumi.output(pagerduty.getTeam({
    name: "devops",
}, { async: true }));
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: me.id,
            type: "user",
        }],
    }],
    teams: [devops.id],
});

Function getUser

getUser(args: GetUserArgs, opts?: pulumi.InvokeOptions): Promise<GetUserResult>

Use this data source to get information about a specific user that you can use for other PagerDuty resources.

Example Usage

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

const me = pulumi.output(pagerduty.getUser({
    email: "me@example.com",
}, { async: true }));
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: me.id,
            type: "user",
        }],
    }],
});

Function getVendor

getVendor(args: GetVendorArgs, opts?: pulumi.InvokeOptions): Promise<GetVendorResult>

Use this data source to get information about a specific vendor that you can use for a service integration (e.g Amazon Cloudwatch, Splunk, Datadog).

Example Usage

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

const datadog = pulumi.output(pagerduty.getVendor({
    name: "Datadog",
}, { async: true }));
const exampleUser = new pagerduty.User("example", {
    email: "125.greenholt.earline@graham.name",
    teams: [pagerduty_team_example.id],
});
const foo = new pagerduty.EscalationPolicy("foo", {
    numLoops: 2,
    rules: [{
        escalationDelayInMinutes: 10,
        targets: [{
            id: exampleUser.id,
            type: "user",
        }],
    }],
});
const exampleService = new pagerduty.Service("example", {
    acknowledgementTimeout: "600",
    autoResolveTimeout: "14400",
    escalationPolicy: pagerduty_escalation_policy_example.id,
});
const exampleServiceIntegration = new pagerduty.ServiceIntegration("example", {
    service: exampleService.id,
    type: "genericEventsApiInboundIntegration",
    vendor: datadog.id,
});

Others

interface AddonArgs

interface AddonArgs

The set of arguments for constructing a Addon resource.

property name

name?: pulumi.Input<string>;

The name of the add-on.

property src

src: pulumi.Input<string>;

The source URL to display in a frame in the PagerDuty UI. HTTPS is required.

interface AddonState

interface AddonState

Input properties used for looking up and filtering Addon resources.

property name

name?: pulumi.Input<string>;

The name of the add-on.

property src

src?: pulumi.Input<string>;

The source URL to display in a frame in the PagerDuty UI. HTTPS is required.

interface BusinessServiceArgs

interface BusinessServiceArgs

The set of arguments for constructing a BusinessService resource.

property description

description?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the business service.

property pointOfContact

pointOfContact?: pulumi.Input<string>;

The owner of the business service.

property type

type?: pulumi.Input<string>;

Default value is businessService. Can also be set as businessServiceReference.

interface BusinessServiceState

interface BusinessServiceState

Input properties used for looking up and filtering BusinessService resources.

property description

description?: pulumi.Input<string>;

property htmlUrl

htmlUrl?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the business service.

property pointOfContact

pointOfContact?: pulumi.Input<string>;

The owner of the business service.

property self

self?: pulumi.Input<string>;

property summary

summary?: pulumi.Input<string>;

property type

type?: pulumi.Input<string>;

Default value is businessService. Can also be set as businessServiceReference.

interface EscalationPolicyArgs

interface EscalationPolicyArgs

The set of arguments for constructing a EscalationPolicy resource.

property description

description?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the escalation policy.

property numLoops

numLoops?: pulumi.Input<number>;

The number of times the escalation policy will repeat after reaching the end of its escalation.

property rules

rules: pulumi.Input<pulumi.Input<EscalationPolicyRule>[]>;

An Escalation rule block. Escalation rules documented below.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

Teams associated with the policy. Account must have the teams ability to use this parameter.

interface EscalationPolicyState

interface EscalationPolicyState

Input properties used for looking up and filtering EscalationPolicy resources.

property description

description?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the escalation policy.

property numLoops

numLoops?: pulumi.Input<number>;

The number of times the escalation policy will repeat after reaching the end of its escalation.

property rules

rules?: pulumi.Input<pulumi.Input<EscalationPolicyRule>[]>;

An Escalation rule block. Escalation rules documented below.

property teams

teams?: pulumi.Input<pulumi.Input<string>[]>;

Teams associated with the policy. Account must have the teams ability to use this parameter.

interface EventRuleArgs

interface EventRuleArgs

The set of arguments for constructing a EventRule resource.

property actionJson

actionJson: pulumi.Input<string>;

A list of one or more actions for each rule. Each action within the list is itself a list.

property advancedConditionJson

advancedConditionJson?: pulumi.Input<string>;

Contains a list of specific conditions including active-between,scheduled-weekly, and frequency-over. The first element in the list is the label for the condition, followed by a list of values for the specific condition. For more details on these conditions see Advanced Condition in the PagerDuty API documentation.

property conditionJson

conditionJson: pulumi.Input<string>;

Contains a list of conditions. The first field in the list is and or or, followed by a list of operators and values.

interface EventRuleState

interface EventRuleState

Input properties used for looking up and filtering EventRule resources.

property actionJson

actionJson?: pulumi.Input<string>;

A list of one or more actions for each rule. Each action within the list is itself a list.

property advancedConditionJson

advancedConditionJson?: pulumi.Input<string>;

Contains a list of specific conditions including active-between,scheduled-weekly, and frequency-over. The first element in the list is the label for the condition, followed by a list of values for the specific condition. For more details on these conditions see Advanced Condition in the PagerDuty API documentation.

property catchAll

catchAll?: pulumi.Input<boolean>;

A boolean that indicates whether the rule is a catch all for the account. This field is read-only through the PagerDuty API.

property conditionJson

conditionJson?: pulumi.Input<string>;

Contains a list of conditions. The first field in the list is and or or, followed by a list of operators and values.

interface ExtensionArgs

interface ExtensionArgs

The set of arguments for constructing a Extension resource.

property config

config?: pulumi.Input<string>;

The configuration of the service extension as string containing plain JSON-encoded data.

property endpointUrl

endpointUrl?: pulumi.Input<string>;

The url of the extension. Note: The endpoint URL is Optional API wise in most cases. But in some cases it is a Required parameter. For example, pagerduty..getExtensionSchema named Generic V2 Webhook doesn’t accept pagerduty..Extension with no endpointUrl, but one with named Slack accepts.

property extensionObjects

extensionObjects: pulumi.Input<pulumi.Input<string>[]>;

This is the objects for which the extension applies (An array of service ids).

property extensionSchema

extensionSchema: pulumi.Input<string>;

This is the schema for this extension.

property name

name?: pulumi.Input<string>;

The name of the service extension.

property type

type?: pulumi.Input<string>;

interface ExtensionState

interface ExtensionState

Input properties used for looking up and filtering Extension resources.

property config

config?: pulumi.Input<string>;

The configuration of the service extension as string containing plain JSON-encoded data.

property endpointUrl

endpointUrl?: pulumi.Input<string>;

The url of the extension. Note: The endpoint URL is Optional API wise in most cases. But in some cases it is a Required parameter. For example, pagerduty..getExtensionSchema named Generic V2 Webhook doesn’t accept pagerduty..Extension with no endpointUrl, but one with named Slack accepts.

property extensionObjects

extensionObjects?: pulumi.Input<pulumi.Input<string>[]>;

This is the objects for which the extension applies (An array of service ids).

property extensionSchema

extensionSchema?: pulumi.Input<string>;

This is the schema for this extension.

property htmlUrl

htmlUrl?: pulumi.Input<string>;

URL at which the entity is uniquely displayed in the Web app

property name

name?: pulumi.Input<string>;

The name of the service extension.

property type

type?: pulumi.Input<string>;

interface GetBusinessServiceArgs

interface GetBusinessServiceArgs

A collection of arguments for invoking getBusinessService.

property name

name: string;

The business service name to use to find a business service in the PagerDuty API.

interface GetBusinessServiceResult

interface GetBusinessServiceResult

A collection of values returned by getBusinessService.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found business service.

function getEnv

getEnv(vars: string[]): string | undefined

function getEnvBoolean

getEnvBoolean(vars: string[]): boolean | undefined

function getEnvNumber

getEnvNumber(vars: string[]): number | undefined

interface GetEscalationPolicyArgs

interface GetEscalationPolicyArgs

A collection of arguments for invoking getEscalationPolicy.

property name

name: string;

The name to use to find an escalation policy in the PagerDuty API.

interface GetEscalationPolicyResult

interface GetEscalationPolicyResult

A collection of values returned by getEscalationPolicy.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found escalation policy.

interface GetExtensionSchemaArgs

interface GetExtensionSchemaArgs

A collection of arguments for invoking getExtensionSchema.

property name

name: string;

The extension name to use to find an extension vendor in the PagerDuty API.

interface GetExtensionSchemaResult

interface GetExtensionSchemaResult

A collection of values returned by getExtensionSchema.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found extension vendor.

property type

type: string;

The generic service type for this extension vendor.

interface GetPriorityArgs

interface GetPriorityArgs

A collection of arguments for invoking getPriority.

property name

name: string;

The name of the priority to find in the PagerDuty API.

interface GetPriorityResult

interface GetPriorityResult

A collection of values returned by getPriority.

property description

description: string;

A description of the found priority.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The name of the found priority.

interface GetScheduleArgs

interface GetScheduleArgs

A collection of arguments for invoking getSchedule.

property name

name: string;

The name to use to find a schedule in the PagerDuty API.

interface GetScheduleResult

interface GetScheduleResult

A collection of values returned by getSchedule.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found schedule.

interface GetServiceArgs

interface GetServiceArgs

A collection of arguments for invoking getService.

property name

name: string;

The service name to use to find a service in the PagerDuty API.

interface GetServiceResult

interface GetServiceResult

A collection of values returned by getService.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found service.

interface GetTeamArgs

interface GetTeamArgs

A collection of arguments for invoking getTeam.

property name

name: string;

The name of the team to find in the PagerDuty API.

interface GetTeamResult

interface GetTeamResult

A collection of values returned by getTeam.

property description

description: string;

A description of the found team.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The name of the found team.

interface GetUserArgs

interface GetUserArgs

A collection of arguments for invoking getUser.

property email

email: string;

The email to use to find a user in the PagerDuty API.

interface GetUserResult

interface GetUserResult

A collection of values returned by getUser.

property email

email: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found user.

interface GetVendorArgs

interface GetVendorArgs

A collection of arguments for invoking getVendor.

property name

name: string;

The vendor name to use to find a vendor in the PagerDuty API.

interface GetVendorResult

interface GetVendorResult

A collection of values returned by getVendor.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property name

name: string;

The short name of the found vendor.

property type

type: string;

The generic service type for this vendor.

function getVersion

getVersion(): string

interface MaintenanceWindowArgs

interface MaintenanceWindowArgs

The set of arguments for constructing a MaintenanceWindow resource.

property description

description?: pulumi.Input<string>;

A description for the maintenance window.

property endTime

endTime: pulumi.Input<string>;

The maintenance window’s end time. This is when the services will start creating incidents again. This date must be in the future and after the startTime.

property services

services: pulumi.Input<pulumi.Input<string>[]>;

A list of service IDs to include in the maintenance window.

property startTime

startTime: pulumi.Input<string>;

The maintenance window’s start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.

interface MaintenanceWindowState

interface MaintenanceWindowState

Input properties used for looking up and filtering MaintenanceWindow resources.

property description

description?: pulumi.Input<string>;

A description for the maintenance window.

property endTime

endTime?: pulumi.Input<string>;

The maintenance window’s end time. This is when the services will start creating incidents again. This date must be in the future and after the startTime.

property services

services?: pulumi.Input<pulumi.Input<string>[]>;

A list of service IDs to include in the maintenance window.

property startTime

startTime?: pulumi.Input<string>;

The maintenance window’s start time. This is when the services will stop creating incidents. If this date is in the past, it will be updated to be the current time.

interface ProviderArgs

interface ProviderArgs

The set of arguments for constructing a Provider resource.

property skipCredentialsValidation

skipCredentialsValidation?: pulumi.Input<boolean>;

property token

token?: pulumi.Input<string>;

interface RulesetArgs

interface RulesetArgs

The set of arguments for constructing a Ruleset resource.

property name

name?: pulumi.Input<string>;

Name of the ruleset.

property team

team?: pulumi.Input<RulesetTeam>;

Reference to the team that owns the ruleset. If none is specified, only admins have access.

interface RulesetRuleArgs

interface RulesetRuleArgs

The set of arguments for constructing a RulesetRule resource.

property actions

actions?: pulumi.Input<RulesetRuleActions>;

Actions to apply to an event if the conditions match.

property conditions

conditions?: pulumi.Input<RulesetRuleConditions>;

Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.

property disabled

disabled?: pulumi.Input<boolean>;

Indicates whether the rule is disabled and would therefore not be evaluated.

property position

position?: pulumi.Input<number>;

Position/index of the rule within the ruleset.

property ruleset

ruleset: pulumi.Input<string>;

The ID of the ruleset that the rule belongs to.

property timeFrame

timeFrame?: pulumi.Input<RulesetRuleTimeFrame>;

Settings for scheduling the rule.

interface RulesetRuleState

interface RulesetRuleState

Input properties used for looking up and filtering RulesetRule resources.

property actions

actions?: pulumi.Input<RulesetRuleActions>;

Actions to apply to an event if the conditions match.

property conditions

conditions?: pulumi.Input<RulesetRuleConditions>;

Conditions evaluated to check if an event matches this event rule. Is always empty for the catch all rule, though.

property disabled

disabled?: pulumi.Input<boolean>;

Indicates whether the rule is disabled and would therefore not be evaluated.

property position

position?: pulumi.Input<number>;

Position/index of the rule within the ruleset.

property ruleset

ruleset?: pulumi.Input<string>;

The ID of the ruleset that the rule belongs to.

property timeFrame

timeFrame?: pulumi.Input<RulesetRuleTimeFrame>;

Settings for scheduling the rule.

interface RulesetState

interface RulesetState

Input properties used for looking up and filtering Ruleset resources.

property name

name?: pulumi.Input<string>;

Name of the ruleset.

property routingKeys

routingKeys?: pulumi.Input<pulumi.Input<string>[]>;

Routing keys routed to this ruleset.

property team

team?: pulumi.Input<RulesetTeam>;

Reference to the team that owns the ruleset. If none is specified, only admins have access.

property type

type?: pulumi.Input<string>;

Type of ruleset. Currently only sets to global.

interface ScheduleArgs

interface ScheduleArgs

The set of arguments for constructing a Schedule resource.

property description

description?: pulumi.Input<string>;

The description of the schedule

property layers

layers: pulumi.Input<pulumi.Input<ScheduleLayer>[]>;

A schedule layer block. Schedule layers documented below.

property name

name?: pulumi.Input<string>;

The name of the schedule.

property overflow

overflow?: pulumi.Input<boolean>;

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow is passed. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: If you don’t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. If you do pass the overflow parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

property timeZone

timeZone: pulumi.Input<string>;

The time zone of the schedule (e.g Europe/Berlin).

interface ScheduleState

interface ScheduleState

Input properties used for looking up and filtering Schedule resources.

property description

description?: pulumi.Input<string>;

The description of the schedule

property layers

layers?: pulumi.Input<pulumi.Input<ScheduleLayer>[]>;

A schedule layer block. Schedule layers documented below.

property name

name?: pulumi.Input<string>;

The name of the schedule.

property overflow

overflow?: pulumi.Input<boolean>;

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow is passed. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from 2011-06-01T10:00:00Z to 2011-06-01T14:00:00Z: If you don’t pass the overflow=true parameter, you will get one schedule entry returned with a start of 2011-06-01T10:00:00Z and end of 2011-06-01T14:00:00Z. If you do pass the overflow parameter, you will get one schedule entry returned with a start of 2011-06-01T00:00:00Z and end of 2011-06-02T00:00:00Z.

property timeZone

timeZone?: pulumi.Input<string>;

The time zone of the schedule (e.g Europe/Berlin).

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property acknowledgementTimeout

acknowledgementTimeout?: pulumi.Input<string>;

Time in seconds that an incident changes to the Triggered State after being Acknowledged. Disabled if set to the "null" string.

property alertCreation

alertCreation?: pulumi.Input<string>;

Must be one of two values. PagerDuty receives events from your monitoring systems and can then create incidents in different ways. Value “createIncidents” is default: events will create an incident that cannot be merged. Value “createAlertsAndIncidents” is the alternative: events will create an alert and then add it to a new incident, these incidents can be merged.

property alertGrouping

alertGrouping?: pulumi.Input<string>;

Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. If not set, each alert will create a separate incident; If value is set to time: All alerts within a specified duration will be grouped into the same incident. This duration is set in the alertGroupingTimeout setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; If value is set to intelligent - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plan.

property alertGroupingTimeout

alertGroupingTimeout?: pulumi.Input<number>;

The duration in minutes within which to automatically group incoming alerts. This setting applies only when alertGrouping is set to time. To continue grouping alerts until the incident is resolved, set this value to 0.

property autoResolveTimeout

autoResolveTimeout?: pulumi.Input<string>;

Time in seconds that an incident is automatically resolved if left open for that long. Disabled if set to the "null" string.

property description

description?: pulumi.Input<string>;

property escalationPolicy

escalationPolicy: pulumi.Input<string>;

The escalation policy used by this service.

property incidentUrgencyRule

incidentUrgencyRule?: pulumi.Input<ServiceIncidentUrgencyRule>;

property name

name?: pulumi.Input<string>;

The name of the service.

property scheduledActions

scheduledActions?: pulumi.Input<pulumi.Input<ServiceScheduledAction>[]>;

property supportHours

supportHours?: pulumi.Input<ServiceSupportHours>;

interface ServiceDependencyArgs

interface ServiceDependencyArgs

The set of arguments for constructing a ServiceDependency resource.

property dependencies

dependencies: pulumi.Input<pulumi.Input<ServiceDependencyDependency>[]>;

The relationship between the supportingService and dependentService.

interface ServiceDependencyState

interface ServiceDependencyState

Input properties used for looking up and filtering ServiceDependency resources.

property dependencies

dependencies?: pulumi.Input<pulumi.Input<ServiceDependencyDependency>[]>;

The relationship between the supportingService and dependentService.

interface ServiceIntegrationArgs

interface ServiceIntegrationArgs

The set of arguments for constructing a ServiceIntegration resource.

property integrationEmail

integrationEmail?: pulumi.Input<string>;

This is the unique fully-qualified email address used for routing emails to this integration for processing.

property integrationKey

integrationKey?: pulumi.Input<string>;

This is the unique key used to route events to this integration when received via the PagerDuty Events API.

property name

name?: pulumi.Input<string>;

The name of the service integration.

property service

service: pulumi.Input<string>;

The ID of the service the integration should belong to.

property type

type?: pulumi.Input<string>;

The service type. Can be: awsCloudwatchInboundIntegration, cloudkickInboundIntegration, eventTransformerApiInboundIntegration, eventsApiV2InboundIntegration (requires service alertCreation to be createAlertsAndIncidents), genericEmailInboundIntegration, genericEventsApiInboundIntegration, keynoteInboundIntegration, nagiosInboundIntegration, pingdomInboundIntegrationor sqlMonitorInboundIntegration.

property vendor

vendor?: pulumi.Input<string>;

The ID of the vendor the integration should integrate with (e.g Datadog or Amazon Cloudwatch).

interface ServiceIntegrationState

interface ServiceIntegrationState

Input properties used for looking up and filtering ServiceIntegration resources.

property htmlUrl

htmlUrl?: pulumi.Input<string>;

URL at which the entity is uniquely displayed in the Web app

property integrationEmail

integrationEmail?: pulumi.Input<string>;

This is the unique fully-qualified email address used for routing emails to this integration for processing.

property integrationKey

integrationKey?: pulumi.Input<string>;

This is the unique key used to route events to this integration when received via the PagerDuty Events API.

property name

name?: pulumi.Input<string>;

The name of the service integration.

property service

service?: pulumi.Input<string>;

The ID of the service the integration should belong to.

property type

type?: pulumi.Input<string>;

The service type. Can be: awsCloudwatchInboundIntegration, cloudkickInboundIntegration, eventTransformerApiInboundIntegration, eventsApiV2InboundIntegration (requires service alertCreation to be createAlertsAndIncidents), genericEmailInboundIntegration, genericEventsApiInboundIntegration, keynoteInboundIntegration, nagiosInboundIntegration, pingdomInboundIntegrationor sqlMonitorInboundIntegration.

property vendor

vendor?: pulumi.Input<string>;

The ID of the vendor the integration should integrate with (e.g Datadog or Amazon Cloudwatch).

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property acknowledgementTimeout

acknowledgementTimeout?: pulumi.Input<string>;

Time in seconds that an incident changes to the Triggered State after being Acknowledged. Disabled if set to the "null" string.

property alertCreation

alertCreation?: pulumi.Input<string>;

Must be one of two values. PagerDuty receives events from your monitoring systems and can then create incidents in different ways. Value “createIncidents” is default: events will create an incident that cannot be merged. Value “createAlertsAndIncidents” is the alternative: events will create an alert and then add it to a new incident, these incidents can be merged.

property alertGrouping

alertGrouping?: pulumi.Input<string>;

Defines how alerts on this service will be automatically grouped into incidents. Note that the alert grouping features are available only on certain plans. If not set, each alert will create a separate incident; If value is set to time: All alerts within a specified duration will be grouped into the same incident. This duration is set in the alertGroupingTimeout setting (described below). Available on Standard, Enterprise, and Event Intelligence plans; If value is set to intelligent - Alerts will be intelligently grouped based on a machine learning model that looks at the alert summary, timing, and the history of grouped alerts. Available on Enterprise and Event Intelligence plan.

property alertGroupingTimeout

alertGroupingTimeout?: pulumi.Input<number>;

The duration in minutes within which to automatically group incoming alerts. This setting applies only when alertGrouping is set to time. To continue grouping alerts until the incident is resolved, set this value to 0.

property autoResolveTimeout

autoResolveTimeout?: pulumi.Input<string>;

Time in seconds that an incident is automatically resolved if left open for that long. Disabled if set to the "null" string.

property createdAt

createdAt?: pulumi.Input<string>;

property description

description?: pulumi.Input<string>;

property escalationPolicy

escalationPolicy?: pulumi.Input<string>;

The escalation policy used by this service.

property htmlUrl

htmlUrl?: pulumi.Input<string>;

property incidentUrgencyRule

incidentUrgencyRule?: pulumi.Input<ServiceIncidentUrgencyRule>;

property lastIncidentTimestamp

lastIncidentTimestamp?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the service.

property scheduledActions

scheduledActions?: pulumi.Input<pulumi.Input<ServiceScheduledAction>[]>;

property status

status?: pulumi.Input<string>;

property supportHours

supportHours?: pulumi.Input<ServiceSupportHours>;

interface TeamArgs

interface TeamArgs

The set of arguments for constructing a Team resource.

property description

description?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the group.

interface TeamMembershipArgs

interface TeamMembershipArgs

The set of arguments for constructing a TeamMembership resource.

property role

role?: pulumi.Input<string>;

The role of the user in the team. One of observer, responder, or manager. Defaults to manager.

property teamId

teamId: pulumi.Input<string>;

The ID of the team in which the user will belong.

property userId

userId: pulumi.Input<string>;

The ID of the user to add to the team.

interface TeamMembershipState

interface TeamMembershipState

Input properties used for looking up and filtering TeamMembership resources.

property role

role?: pulumi.Input<string>;

The role of the user in the team. One of observer, responder, or manager. Defaults to manager.

property teamId

teamId?: pulumi.Input<string>;

The ID of the team in which the user will belong.

property userId

userId?: pulumi.Input<string>;

The ID of the user to add to the team.

interface TeamState

interface TeamState

Input properties used for looking up and filtering Team resources.

property description

description?: pulumi.Input<string>;

property htmlUrl

htmlUrl?: pulumi.Input<string>;

URL at which the entity is uniquely displayed in the Web app

property name

name?: pulumi.Input<string>;

The name of the group.

interface UserArgs

interface UserArgs

The set of arguments for constructing a User resource.

property color

color?: pulumi.Input<string>;

The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.

property description

description?: pulumi.Input<string>;

property email

email: pulumi.Input<string>;

The user’s email address.

property jobTitle

jobTitle?: pulumi.Input<string>;

The user’s title.

property name

name?: pulumi.Input<string>;

The name of the user.

property role

role?: pulumi.Input<string>;

The user role. Account must have the readOnlyUsers ability to set a user as a readOnlyUser. Can be admin, limitedUser, observer, owner, readOnlyUser or user

property teams

DEPRECATED Use the 'pagerduty_team_membership' resource instead.
teams?: pulumi.Input<pulumi.Input<string>[]>;

A list of teams the user should belong to. Please use pagerduty..TeamMembership instead.

property timeZone

timeZone?: pulumi.Input<string>;

The timezone of the user

interface UserContactMethodArgs

interface UserContactMethodArgs

The set of arguments for constructing a UserContactMethod resource.

property address

address: pulumi.Input<string>;

The “address” to deliver to: email, phone number, etc., depending on the type.

property countryCode

countryCode?: pulumi.Input<number>;

The 1-to-3 digit country calling code. Required when using phoneContactMethod or smsContactMethod.

property label

label: pulumi.Input<string>;

The label (e.g., “Work”, “Mobile”, etc.).

property sendShortEmail

sendShortEmail?: pulumi.Input<boolean>;

Send an abbreviated email message instead of the standard email output.

property type

type: pulumi.Input<string>;

The contact method type. May be (emailContactMethod, phoneContactMethod, smsContactMethod, pushNotificationContactMethod).

property userId

userId: pulumi.Input<string>;

The ID of the user.

interface UserContactMethodState

interface UserContactMethodState

Input properties used for looking up and filtering UserContactMethod resources.

property address

address?: pulumi.Input<string>;

The “address” to deliver to: email, phone number, etc., depending on the type.

property blacklisted

blacklisted?: pulumi.Input<boolean>;

If true, this phone has been blacklisted by PagerDuty and no messages will be sent to it.

property countryCode

countryCode?: pulumi.Input<number>;

The 1-to-3 digit country calling code. Required when using phoneContactMethod or smsContactMethod.

property enabled

enabled?: pulumi.Input<boolean>;

If true, this phone is capable of receiving SMS messages.

property label

label?: pulumi.Input<string>;

The label (e.g., “Work”, “Mobile”, etc.).

property sendShortEmail

sendShortEmail?: pulumi.Input<boolean>;

Send an abbreviated email message instead of the standard email output.

property type

type?: pulumi.Input<string>;

The contact method type. May be (emailContactMethod, phoneContactMethod, smsContactMethod, pushNotificationContactMethod).

property userId

userId?: pulumi.Input<string>;

The ID of the user.

interface UserNotificationRuleArgs

interface UserNotificationRuleArgs

The set of arguments for constructing a UserNotificationRule resource.

property contactMethod

contactMethod: pulumi.Input<UserNotificationRuleContactMethod>;

A contact method block, configured as a block described below.

property startDelayInMinutes

startDelayInMinutes: pulumi.Input<number>;

The delay before firing the rule, in minutes.

property urgency

urgency: pulumi.Input<string>;

Which incident urgency this rule is used for. Account must have the urgencies ability to have a low urgency notification rule. Can be high or low.

property userId

userId: pulumi.Input<string>;

The ID of the user.

interface UserNotificationRuleState

interface UserNotificationRuleState

Input properties used for looking up and filtering UserNotificationRule resources.

property contactMethod

contactMethod?: pulumi.Input<UserNotificationRuleContactMethod>;

A contact method block, configured as a block described below.

property startDelayInMinutes

startDelayInMinutes?: pulumi.Input<number>;

The delay before firing the rule, in minutes.

property urgency

urgency?: pulumi.Input<string>;

Which incident urgency this rule is used for. Account must have the urgencies ability to have a low urgency notification rule. Can be high or low.

property userId

userId?: pulumi.Input<string>;

The ID of the user.

interface UserState

interface UserState

Input properties used for looking up and filtering User resources.

property avatarUrl

avatarUrl?: pulumi.Input<string>;

The URL of the user’s avatar.

property color

color?: pulumi.Input<string>;

The schedule color for the user. Valid options are purple, red, green, blue, teal, orange, brown, turquoise, dark-slate-blue, cayenne, orange-red, dark-orchid, dark-slate-grey, lime, dark-magenta, lime-green, midnight-blue, deep-pink, dark-green, dark-orange, dark-cyan, darkolive-green, dark-slate-gray, grey20, firebrick, maroon, crimson, dark-red, dark-goldenrod, chocolate, medium-violet-red, sea-green, olivedrab, forest-green, dark-olive-green, blue-violet, royal-blue, indigo, slate-blue, saddle-brown, or steel-blue.

property description

description?: pulumi.Input<string>;

property email

email?: pulumi.Input<string>;

The user’s email address.

property htmlUrl

htmlUrl?: pulumi.Input<string>;

URL at which the entity is uniquely displayed in the Web app

property invitationSent

invitationSent?: pulumi.Input<boolean>;

If true, the user has an outstanding invitation.

property jobTitle

jobTitle?: pulumi.Input<string>;

The user’s title.

property name

name?: pulumi.Input<string>;

The name of the user.

property role

role?: pulumi.Input<string>;

The user role. Account must have the readOnlyUsers ability to set a user as a readOnlyUser. Can be admin, limitedUser, observer, owner, readOnlyUser or user

property teams

DEPRECATED Use the 'pagerduty_team_membership' resource instead.
teams?: pulumi.Input<pulumi.Input<string>[]>;

A list of teams the user should belong to. Please use pagerduty..TeamMembership instead.

property timeZone

timeZone?: pulumi.Input<string>;

The timezone of the user