Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. OncallEscalation
Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
pulumiverse/pulumi-grafana

grafana.OncallEscalation

Explore with Pulumi AI

Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
pulumiverse/pulumi-grafana
Deprecated: grafana.index/oncallescalation.OncallEscalation has been deprecated in favor of grafana.oncall/escalation.Escalation

Create OncallEscalation Resource

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

Constructor syntax

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

@overload
def OncallEscalation(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     action_to_trigger: Optional[str] = None,
                     duration: Optional[int] = None,
                     escalation_chain_id: Optional[str] = None,
                     group_to_notify: Optional[str] = None,
                     important: Optional[bool] = None,
                     notify_if_time_from: Optional[str] = None,
                     notify_if_time_to: Optional[str] = None,
                     notify_on_call_from_schedule: Optional[str] = None,
                     notify_to_team_members: Optional[str] = None,
                     persons_to_notifies: Optional[Sequence[str]] = None,
                     persons_to_notify_next_each_times: Optional[Sequence[str]] = None,
                     position: Optional[int] = None,
                     severity: Optional[str] = None,
                     type: Optional[str] = None)
func NewOncallEscalation(ctx *Context, name string, args OncallEscalationArgs, opts ...ResourceOption) (*OncallEscalation, error)
public OncallEscalation(string name, OncallEscalationArgs args, CustomResourceOptions? opts = null)
public OncallEscalation(String name, OncallEscalationArgs args)
public OncallEscalation(String name, OncallEscalationArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. OncallEscalationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. OncallEscalationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. OncallEscalationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. OncallEscalationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OncallEscalationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

OncallEscalation Resource Properties

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

Inputs

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

The OncallEscalation resource accepts the following input properties:

EscalationChainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the escalation chain.
Position This property is required. int
The position of the escalation step (starts from 0).
Type This property is required. string
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
ActionToTrigger string
The ID of an Action for trigger_webhook type step.
Duration int
The duration of delay for wait type step. (60-86400) seconds
GroupToNotify string
The ID of a User Group for notifyusergroup type step.
Important bool
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
NotifyIfTimeFrom string
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
NotifyIfTimeTo string
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
NotifyOnCallFromSchedule string
ID of a Schedule for notifyoncallfromschedule type step.
NotifyToTeamMembers string
The ID of a Team for a notifyteammembers type step.
PersonsToNotifies List<string>
The list of ID's of users for notify_persons type step.
PersonsToNotifyNextEachTimes List<string>
The list of ID's of users for notifypersonnexteachtime type step.
Severity string
The severity of the incident for declare_incident type step.
EscalationChainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the escalation chain.
Position This property is required. int
The position of the escalation step (starts from 0).
Type This property is required. string
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
ActionToTrigger string
The ID of an Action for trigger_webhook type step.
Duration int
The duration of delay for wait type step. (60-86400) seconds
GroupToNotify string
The ID of a User Group for notifyusergroup type step.
Important bool
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
NotifyIfTimeFrom string
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
NotifyIfTimeTo string
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
NotifyOnCallFromSchedule string
ID of a Schedule for notifyoncallfromschedule type step.
NotifyToTeamMembers string
The ID of a Team for a notifyteammembers type step.
PersonsToNotifies []string
The list of ID's of users for notify_persons type step.
PersonsToNotifyNextEachTimes []string
The list of ID's of users for notifypersonnexteachtime type step.
Severity string
The severity of the incident for declare_incident type step.
escalationChainId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the escalation chain.
position This property is required. Integer
The position of the escalation step (starts from 0).
type This property is required. String
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
actionToTrigger String
The ID of an Action for trigger_webhook type step.
duration Integer
The duration of delay for wait type step. (60-86400) seconds
groupToNotify String
The ID of a User Group for notifyusergroup type step.
important Boolean
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notifyIfTimeFrom String
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notifyIfTimeTo String
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notifyOnCallFromSchedule String
ID of a Schedule for notifyoncallfromschedule type step.
notifyToTeamMembers String
The ID of a Team for a notifyteammembers type step.
personsToNotifies List<String>
The list of ID's of users for notify_persons type step.
personsToNotifyNextEachTimes List<String>
The list of ID's of users for notifypersonnexteachtime type step.
severity String
The severity of the incident for declare_incident type step.
escalationChainId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the escalation chain.
position This property is required. number
The position of the escalation step (starts from 0).
type This property is required. string
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
actionToTrigger string
The ID of an Action for trigger_webhook type step.
duration number
The duration of delay for wait type step. (60-86400) seconds
groupToNotify string
The ID of a User Group for notifyusergroup type step.
important boolean
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notifyIfTimeFrom string
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notifyIfTimeTo string
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notifyOnCallFromSchedule string
ID of a Schedule for notifyoncallfromschedule type step.
notifyToTeamMembers string
The ID of a Team for a notifyteammembers type step.
personsToNotifies string[]
The list of ID's of users for notify_persons type step.
personsToNotifyNextEachTimes string[]
The list of ID's of users for notifypersonnexteachtime type step.
severity string
The severity of the incident for declare_incident type step.
escalation_chain_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the escalation chain.
position This property is required. int
The position of the escalation step (starts from 0).
type This property is required. str
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
action_to_trigger str
The ID of an Action for trigger_webhook type step.
duration int
The duration of delay for wait type step. (60-86400) seconds
group_to_notify str
The ID of a User Group for notifyusergroup type step.
important bool
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notify_if_time_from str
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notify_if_time_to str
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notify_on_call_from_schedule str
ID of a Schedule for notifyoncallfromschedule type step.
notify_to_team_members str
The ID of a Team for a notifyteammembers type step.
persons_to_notifies Sequence[str]
The list of ID's of users for notify_persons type step.
persons_to_notify_next_each_times Sequence[str]
The list of ID's of users for notifypersonnexteachtime type step.
severity str
The severity of the incident for declare_incident type step.
escalationChainId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the escalation chain.
position This property is required. Number
The position of the escalation step (starts from 0).
type This property is required. String
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
actionToTrigger String
The ID of an Action for trigger_webhook type step.
duration Number
The duration of delay for wait type step. (60-86400) seconds
groupToNotify String
The ID of a User Group for notifyusergroup type step.
important Boolean
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notifyIfTimeFrom String
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notifyIfTimeTo String
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notifyOnCallFromSchedule String
ID of a Schedule for notifyoncallfromschedule type step.
notifyToTeamMembers String
The ID of a Team for a notifyteammembers type step.
personsToNotifies List<String>
The list of ID's of users for notify_persons type step.
personsToNotifyNextEachTimes List<String>
The list of ID's of users for notifypersonnexteachtime type step.
severity String
The severity of the incident for declare_incident type step.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing OncallEscalation Resource

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

public static get(name: string, id: Input<ID>, state?: OncallEscalationState, opts?: CustomResourceOptions): OncallEscalation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_to_trigger: Optional[str] = None,
        duration: Optional[int] = None,
        escalation_chain_id: Optional[str] = None,
        group_to_notify: Optional[str] = None,
        important: Optional[bool] = None,
        notify_if_time_from: Optional[str] = None,
        notify_if_time_to: Optional[str] = None,
        notify_on_call_from_schedule: Optional[str] = None,
        notify_to_team_members: Optional[str] = None,
        persons_to_notifies: Optional[Sequence[str]] = None,
        persons_to_notify_next_each_times: Optional[Sequence[str]] = None,
        position: Optional[int] = None,
        severity: Optional[str] = None,
        type: Optional[str] = None) -> OncallEscalation
func GetOncallEscalation(ctx *Context, name string, id IDInput, state *OncallEscalationState, opts ...ResourceOption) (*OncallEscalation, error)
public static OncallEscalation Get(string name, Input<string> id, OncallEscalationState? state, CustomResourceOptions? opts = null)
public static OncallEscalation get(String name, Output<String> id, OncallEscalationState state, CustomResourceOptions options)
resources:  _:    type: grafana:OncallEscalation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ActionToTrigger string
The ID of an Action for trigger_webhook type step.
Duration int
The duration of delay for wait type step. (60-86400) seconds
EscalationChainId Changes to this property will trigger replacement. string
The ID of the escalation chain.
GroupToNotify string
The ID of a User Group for notifyusergroup type step.
Important bool
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
NotifyIfTimeFrom string
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
NotifyIfTimeTo string
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
NotifyOnCallFromSchedule string
ID of a Schedule for notifyoncallfromschedule type step.
NotifyToTeamMembers string
The ID of a Team for a notifyteammembers type step.
PersonsToNotifies List<string>
The list of ID's of users for notify_persons type step.
PersonsToNotifyNextEachTimes List<string>
The list of ID's of users for notifypersonnexteachtime type step.
Position int
The position of the escalation step (starts from 0).
Severity string
The severity of the incident for declare_incident type step.
Type string
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
ActionToTrigger string
The ID of an Action for trigger_webhook type step.
Duration int
The duration of delay for wait type step. (60-86400) seconds
EscalationChainId Changes to this property will trigger replacement. string
The ID of the escalation chain.
GroupToNotify string
The ID of a User Group for notifyusergroup type step.
Important bool
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
NotifyIfTimeFrom string
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
NotifyIfTimeTo string
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
NotifyOnCallFromSchedule string
ID of a Schedule for notifyoncallfromschedule type step.
NotifyToTeamMembers string
The ID of a Team for a notifyteammembers type step.
PersonsToNotifies []string
The list of ID's of users for notify_persons type step.
PersonsToNotifyNextEachTimes []string
The list of ID's of users for notifypersonnexteachtime type step.
Position int
The position of the escalation step (starts from 0).
Severity string
The severity of the incident for declare_incident type step.
Type string
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
actionToTrigger String
The ID of an Action for trigger_webhook type step.
duration Integer
The duration of delay for wait type step. (60-86400) seconds
escalationChainId Changes to this property will trigger replacement. String
The ID of the escalation chain.
groupToNotify String
The ID of a User Group for notifyusergroup type step.
important Boolean
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notifyIfTimeFrom String
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notifyIfTimeTo String
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notifyOnCallFromSchedule String
ID of a Schedule for notifyoncallfromschedule type step.
notifyToTeamMembers String
The ID of a Team for a notifyteammembers type step.
personsToNotifies List<String>
The list of ID's of users for notify_persons type step.
personsToNotifyNextEachTimes List<String>
The list of ID's of users for notifypersonnexteachtime type step.
position Integer
The position of the escalation step (starts from 0).
severity String
The severity of the incident for declare_incident type step.
type String
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
actionToTrigger string
The ID of an Action for trigger_webhook type step.
duration number
The duration of delay for wait type step. (60-86400) seconds
escalationChainId Changes to this property will trigger replacement. string
The ID of the escalation chain.
groupToNotify string
The ID of a User Group for notifyusergroup type step.
important boolean
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notifyIfTimeFrom string
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notifyIfTimeTo string
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notifyOnCallFromSchedule string
ID of a Schedule for notifyoncallfromschedule type step.
notifyToTeamMembers string
The ID of a Team for a notifyteammembers type step.
personsToNotifies string[]
The list of ID's of users for notify_persons type step.
personsToNotifyNextEachTimes string[]
The list of ID's of users for notifypersonnexteachtime type step.
position number
The position of the escalation step (starts from 0).
severity string
The severity of the incident for declare_incident type step.
type string
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
action_to_trigger str
The ID of an Action for trigger_webhook type step.
duration int
The duration of delay for wait type step. (60-86400) seconds
escalation_chain_id Changes to this property will trigger replacement. str
The ID of the escalation chain.
group_to_notify str
The ID of a User Group for notifyusergroup type step.
important bool
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notify_if_time_from str
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notify_if_time_to str
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notify_on_call_from_schedule str
ID of a Schedule for notifyoncallfromschedule type step.
notify_to_team_members str
The ID of a Team for a notifyteammembers type step.
persons_to_notifies Sequence[str]
The list of ID's of users for notify_persons type step.
persons_to_notify_next_each_times Sequence[str]
The list of ID's of users for notifypersonnexteachtime type step.
position int
The position of the escalation step (starts from 0).
severity str
The severity of the incident for declare_incident type step.
type str
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident
actionToTrigger String
The ID of an Action for trigger_webhook type step.
duration Number
The duration of delay for wait type step. (60-86400) seconds
escalationChainId Changes to this property will trigger replacement. String
The ID of the escalation chain.
groupToNotify String
The ID of a User Group for notifyusergroup type step.
important Boolean
Will activate "important" personal notification rules. Actual for steps: notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, notifyusergroup and notifyteam_members
notifyIfTimeFrom String
The beginning of the time interval for notifyiftimefromto type step in UTC (for example 08:00:00Z).
notifyIfTimeTo String
The end of the time interval for notifyiftimefromto type step in UTC (for example 18:00:00Z).
notifyOnCallFromSchedule String
ID of a Schedule for notifyoncallfromschedule type step.
notifyToTeamMembers String
The ID of a Team for a notifyteammembers type step.
personsToNotifies List<String>
The list of ID's of users for notify_persons type step.
personsToNotifyNextEachTimes List<String>
The list of ID's of users for notifypersonnexteachtime type step.
position Number
The position of the escalation step (starts from 0).
severity String
The severity of the incident for declare_incident type step.
type String
The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteammembers, declareincident

Import

$ pulumi import grafana:index/oncallEscalation:OncallEscalation name "{{ id }}"
Copy

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

Package Details

Repository
grafana pulumiverse/pulumi-grafana
License
Apache-2.0
Notes
This Pulumi package is based on the grafana Terraform Provider.
Grafana v0.16.1 published on Saturday, Mar 15, 2025 by pulumiverse
pulumiverse/pulumi-grafana