1. Docs
  2. Reference
  3. API
  4. @pulumi/pagerduty
  5. types
  6. input

Module types/input

APIs

APIs

interface EscalationPolicyRule

interface EscalationPolicyRule

property escalationDelayInMinutes

escalationDelayInMinutes: pulumi.Input<number>;

The number of minutes before an unacknowledged incident escalates away from this rule.

property id

id?: pulumi.Input<string>;

A target ID

property targets

targets: pulumi.Input<pulumi.Input<EscalationPolicyRuleTarget>[]>;

interface EscalationPolicyRuleTarget

interface EscalationPolicyRuleTarget

property id

id: pulumi.Input<string>;

A target ID

property type

type?: pulumi.Input<string>;

Can be user, schedule, userReference or scheduleReference. Defaults to userReference

interface RulesetRuleActions

interface RulesetRuleActions

property annotates

annotates?: pulumi.Input<pulumi.Input<RulesetRuleActionsAnnotate>[]>;

Note added to the event.

property eventActions

eventActions?: pulumi.Input<pulumi.Input<RulesetRuleActionsEventAction>[]>;

property extractions

extractions?: pulumi.Input<pulumi.Input<RulesetRuleActionsExtraction>[]>;

Allows you to copy important data from one event field to another. Extraction rules must use valid RE2 regular expression syntax. Extraction objects consist of the following fields:

property priorities

priorities?: pulumi.Input<pulumi.Input<RulesetRuleActionsPriority>[]>;

The ID of the priority applied to the event.

property routes

routes?: pulumi.Input<pulumi.Input<RulesetRuleActionsRoute>[]>;

The ID of the service where the event will be routed.

property severities

severities?: pulumi.Input<pulumi.Input<RulesetRuleActionsSeverity>[]>;

The severity level of the event. Can be either info,error,warning, or critical.

property suppresses

suppresses?: pulumi.Input<pulumi.Input<RulesetRuleActionsSuppress>[]>;

Controls whether an alert is suppressed (does not create an incident).

interface RulesetRuleActionsAnnotate

interface RulesetRuleActionsAnnotate

property value

value?: pulumi.Input<string>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleActionsEventAction

interface RulesetRuleActionsEventAction

property value

value?: pulumi.Input<string>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleActionsExtraction

interface RulesetRuleActionsExtraction

property regex

regex?: pulumi.Input<string>;

The conditions that need to be met for the extraction to happen. * NOTE: A rule can have multiple extraction objects attributed to it.

property source

source?: pulumi.Input<string>;

Field where the data is being copied from.

property target

target?: pulumi.Input<string>;

Field where the data is being copied to.

interface RulesetRuleActionsPriority

interface RulesetRuleActionsPriority

property value

value?: pulumi.Input<string>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleActionsRoute

interface RulesetRuleActionsRoute

property value

value?: pulumi.Input<string>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleActionsSeverity

interface RulesetRuleActionsSeverity

property value

value?: pulumi.Input<string>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleActionsSuppress

interface RulesetRuleActionsSuppress

property thresholdTimeAmount

thresholdTimeAmount?: pulumi.Input<number>;

The number value of the thresholdTimeUnit before an incident is created.

property thresholdTimeUnit

thresholdTimeUnit?: pulumi.Input<string>;

The minutes,hours, or days that the thresholdTimeAmount should be measured.

property thresholdValue

thresholdValue?: pulumi.Input<number>;

The number of alerts that should be suppressed.

property value

value?: pulumi.Input<boolean>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleConditions

interface RulesetRuleConditions

property operator

operator?: pulumi.Input<string>;

Operator to combine sub-conditions. Can be and or or.

property subconditions

subconditions?: pulumi.Input<pulumi.Input<RulesetRuleConditionsSubcondition>[]>;

List of sub-conditions that define the the condition.

interface RulesetRuleConditionsSubcondition

interface RulesetRuleConditionsSubcondition

property operator

operator?: pulumi.Input<string>;

Type of operator to apply to the sub-condition. Can be exists,nexists,equals,nequals,contains,ncontains,matches, or nmatches.

property parameters

parameters?: pulumi.Input<pulumi.Input<RulesetRuleConditionsSubconditionParameter>[]>;

Parameter for the sub-condition. It requires both a path and value to be set.

interface RulesetRuleConditionsSubconditionParameter

interface RulesetRuleConditionsSubconditionParameter

property path

path?: pulumi.Input<string>;

property value

value?: pulumi.Input<string>;

Boolean value that indicates if the alert should be suppressed before the indicated threshold values are met.

interface RulesetRuleTimeFrame

interface RulesetRuleTimeFrame

property activeBetweens

activeBetweens?: pulumi.Input<pulumi.Input<RulesetRuleTimeFrameActiveBetween>[]>;

Values for executing the rule during a specific time period.

property scheduledWeeklies

scheduledWeeklies?: pulumi.Input<pulumi.Input<RulesetRuleTimeFrameScheduledWeekly>[]>;

Values for executing the rule on a recurring schedule.

interface RulesetRuleTimeFrameActiveBetween

interface RulesetRuleTimeFrameActiveBetween

property endTime

endTime?: pulumi.Input<number>;

Ending of the scheduled time when the rule should execute. Unix timestamp in milliseconds.

property startTime

startTime?: pulumi.Input<number>;

Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a startTime of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the startTime was 3,600,000 the it would be active starting at 01:00.

interface RulesetRuleTimeFrameScheduledWeekly

interface RulesetRuleTimeFrameScheduledWeekly

property duration

duration?: pulumi.Input<number>;

Length of time the schedule will be active. Unix timestamp in milliseconds.

property startTime

startTime?: pulumi.Input<number>;

Time when the schedule will start. Unix timestamp in milliseconds. For example, if you have a rule with a startTime of 0 and a duration of 60,000 then that rule would be active from 00:00 to 00:01. If the startTime was 3,600,000 the it would be active starting at 01:00.

property timezone

timezone?: pulumi.Input<string>;

Timezone for the given schedule.

property weekdays

weekdays?: pulumi.Input<pulumi.Input<number>[]>;

An integer array representing which days during the week the rule executes. For example weekdays = [1,3,7] would execute on Monday, Wednesday and Sunday.

interface RulesetTeam

interface RulesetTeam

property id

id: pulumi.Input<string>;

The ID of the ruleset.

interface ScheduleLayer

interface ScheduleLayer

property end

end?: pulumi.Input<string>;

The end time of the schedule layer. If not specified, the layer does not end.

property id

id?: pulumi.Input<string>;

The ID of the schedule

property name

name?: pulumi.Input<string>;

The name of the schedule layer.

property restrictions

restrictions?: pulumi.Input<pulumi.Input<ScheduleLayerRestriction>[]>;

A schedule layer restriction block. Restriction blocks documented below.

property rotationTurnLengthSeconds

rotationTurnLengthSeconds: pulumi.Input<number>;

The duration of each on-call shift in seconds.

property rotationVirtualStart

rotationVirtualStart: pulumi.Input<string>;

The effective start time of the schedule layer. This can be before the start time of the schedule.

property start

start: pulumi.Input<string>;

The start time of the schedule layer. This value will not be read back from the PagerDuty API because the API will always return a new start time, which represents the last updated time of the schedule layer.

property users

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

The ordered list of users on this layer. The position of the user on the list determines their order in the layer.

interface ScheduleLayerRestriction

interface ScheduleLayerRestriction

property durationSeconds

durationSeconds: pulumi.Input<number>;

The duration of the restriction in seconds.

property startDayOfWeek

startDayOfWeek?: pulumi.Input<number>;

Number of the day when restriction starts. From 1 to 7 where 1 is Monday and 7 is Sunday.

property startTimeOfDay

startTimeOfDay: pulumi.Input<string>;

The start time in HH:mm:ss format.

property type

type: pulumi.Input<string>;

Can be dailyRestriction or weeklyRestriction

interface ServiceDependencyDependency

interface ServiceDependencyDependency

property dependentServices

dependentServices: pulumi.Input<pulumi.Input<ServiceDependencyDependencyDependentService>[]>;

The service that id dependent on the supporting service.

property supportingServices

supportingServices: pulumi.Input<pulumi.Input<ServiceDependencyDependencySupportingService>[]>;

The service that supports the dependent service.

property type

type?: pulumi.Input<string>;

interface ServiceDependencyDependencyDependentService

interface ServiceDependencyDependencyDependentService

property id

id: pulumi.Input<string>;

The ID of the service dependency.

property type

type: pulumi.Input<string>;

interface ServiceDependencyDependencySupportingService

interface ServiceDependencyDependencySupportingService

property id

id: pulumi.Input<string>;

The ID of the service dependency.

property type

type: pulumi.Input<string>;

interface ServiceIncidentUrgencyRule

interface ServiceIncidentUrgencyRule

property duringSupportHours

duringSupportHours?: pulumi.Input<ServiceIncidentUrgencyRuleDuringSupportHours>;

Incidents’ urgency during support hours.

property outsideSupportHours

outsideSupportHours?: pulumi.Input<ServiceIncidentUrgencyRuleOutsideSupportHours>;

Incidents’ urgency outside of support hours.

property type

type: pulumi.Input<string>;

The type of scheduled action. Currently, this must be set to urgencyChange.

property urgency

urgency?: pulumi.Input<string>;

The urgency: low Notify responders (does not escalate), high (follows escalation rules) or severityBased Set’s the urgency of the incident based on the severity set by the triggering monitoring tool.

interface ServiceIncidentUrgencyRuleDuringSupportHours

interface ServiceIncidentUrgencyRuleDuringSupportHours

property type

type?: pulumi.Input<string>;

The type of scheduled action. Currently, this must be set to urgencyChange.

property urgency

urgency?: pulumi.Input<string>;

The urgency: low Notify responders (does not escalate), high (follows escalation rules) or severityBased Set’s the urgency of the incident based on the severity set by the triggering monitoring tool.

interface ServiceIncidentUrgencyRuleOutsideSupportHours

interface ServiceIncidentUrgencyRuleOutsideSupportHours

property type

type?: pulumi.Input<string>;

The type of scheduled action. Currently, this must be set to urgencyChange.

property urgency

urgency?: pulumi.Input<string>;

The urgency: low Notify responders (does not escalate), high (follows escalation rules) or severityBased Set’s the urgency of the incident based on the severity set by the triggering monitoring tool.

interface ServiceScheduledAction

interface ServiceScheduledAction

property ats

ats?: pulumi.Input<pulumi.Input<ServiceScheduledActionAt>[]>;

A block representing when the scheduled action will occur.

property toUrgency

toUrgency?: pulumi.Input<string>;

The urgency to change to: low (does not escalate), or high (follows escalation rules).

property type

type?: pulumi.Input<string>;

The type of scheduled action. Currently, this must be set to urgencyChange.

interface ServiceScheduledActionAt

interface ServiceScheduledActionAt

property name

name?: pulumi.Input<string>;

Designates either the start or the end of the scheduled action. Can be supportHoursStart or supportHoursEnd.

property type

type?: pulumi.Input<string>;

The type of time specification. Currently, this must be set to namedTime.

interface ServiceSupportHours

interface ServiceSupportHours

property daysOfWeeks

daysOfWeeks?: pulumi.Input<pulumi.Input<number>[]>;

Array of days of week as integers. 1 to 7, 1 being Monday and 7 being Sunday.

property endTime

endTime?: pulumi.Input<string>;

The support hours’ ending time of day.

property startTime

startTime?: pulumi.Input<string>;

The support hours’ starting time of day.

property timeZone

timeZone?: pulumi.Input<string>;

The time zone for the support hours.

property type

type?: pulumi.Input<string>;

The type of scheduled action. Currently, this must be set to urgencyChange.

interface UserNotificationRuleContactMethod

interface UserNotificationRuleContactMethod

property id

id: pulumi.Input<string>;

The id of the referenced contact method.

property type

type: pulumi.Input<string>;

The type of contact method. Can be emailContactMethod, phoneContactMethod, pushNotificationContactMethod or smsContactMethod.