Grafana v0.7.0, Nov 5 24

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

grafana.OncallEscalation

Explore with Pulumi AI

Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

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,
                     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 string: The unique name of the resource.
args OncallEscalationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args 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 string: The unique name of the resource.
args OncallEscalationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OncallEscalationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args 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 string: The ID of the escalation chain.
Position int: The position of the escalation step (starts from 0).
Type string: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members
ActionToTrigger string: The ID of an Action for trigger_webhook type step.
Duration int: The duration of delay for wait type step.
GroupToNotify string: The ID of a User Group for notifyusergroup type step.
Important bool: Will activate "important" personal notification rules. Actual for steps: notifypersons, notifyoncallfromschedule and notifyusergroup,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.

EscalationChainId string: The ID of the escalation chain.
Position int: The position of the escalation step (starts from 0).
Type string: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members
ActionToTrigger string: The ID of an Action for trigger_webhook type step.
Duration int: The duration of delay for wait type step.
GroupToNotify string: The ID of a User Group for notifyusergroup type step.
Important bool: Will activate "important" personal notification rules. Actual for steps: notifypersons, notifyoncallfromschedule and notifyusergroup,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.

escalationChainId String: The ID of the escalation chain.
position Integer: The position of the escalation step (starts from 0).
type String: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members
actionToTrigger String: The ID of an Action for trigger_webhook type step.
duration Integer: The duration of delay for wait type step.
groupToNotify String: The ID of a User Group for notifyusergroup type step.
important Boolean: Will activate "important" personal notification rules. Actual for steps: notifypersons, notifyoncallfromschedule and notifyusergroup,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.

escalationChainId string: The ID of the escalation chain.
position number: The position of the escalation step (starts from 0).
type string: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members
actionToTrigger string: The ID of an Action for trigger_webhook type step.
duration number: The duration of delay for wait type step.
groupToNotify string: The ID of a User Group for notifyusergroup type step.
important boolean: Will activate "important" personal notification rules. Actual for steps: notifypersons, notifyoncallfromschedule and notifyusergroup,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.

escalation_chain_id str: The ID of the escalation chain.
position int: The position of the escalation step (starts from 0).
type str: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members
action_to_trigger str: The ID of an Action for trigger_webhook type step.
duration int: The duration of delay for wait type step.
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, notifyoncallfromschedule and notifyusergroup,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.

escalationChainId String: The ID of the escalation chain.
position Number: The position of the escalation step (starts from 0).
type String: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members
actionToTrigger String: The ID of an Action for trigger_webhook type step.
duration Number: The duration of delay for wait type step.
groupToNotify String: The ID of a User Group for notifyusergroup type step.
important Boolean: Will activate "important" personal notification rules. Actual for steps: notifypersons, notifyoncallfromschedule and notifyusergroup,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.

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,
        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)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ActionToTrigger string: The ID of an Action for trigger_webhook type step.
Duration int: The duration of delay for wait type step.
EscalationChainId 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, notifyoncallfromschedule and notifyusergroup,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).
Type string: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members

ActionToTrigger string: The ID of an Action for trigger_webhook type step.
Duration int: The duration of delay for wait type step.
EscalationChainId 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, notifyoncallfromschedule and notifyusergroup,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).
Type string: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members

actionToTrigger String: The ID of an Action for trigger_webhook type step.
duration Integer: The duration of delay for wait type step.
escalationChainId 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, notifyoncallfromschedule and notifyusergroup,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).
type String: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members

actionToTrigger string: The ID of an Action for trigger_webhook type step.
duration number: The duration of delay for wait type step.
escalationChainId 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, notifyoncallfromschedule and notifyusergroup,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).
type string: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members

action_to_trigger str: The ID of an Action for trigger_webhook type step.
duration int: The duration of delay for wait type step.
escalation_chain_id 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, notifyoncallfromschedule and notifyusergroup,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).
type str: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members

actionToTrigger String: The ID of an Action for trigger_webhook type step.
duration Number: The duration of delay for wait type step.
escalationChainId 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, notifyoncallfromschedule and notifyusergroup,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).
type String: The type of escalation policy. Can be wait, notifypersons, notifypersonnexteachtime, notifyoncallfromschedule, triggerwebhook, notifyusergroup, resolve, notifywholechannel, notifyiftimefromto, repeatescalation, notifyteam_members

Import

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

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.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse

pulumiverse/pulumi-grafana

grafana.OncallEscalation

On this page

On this page

Create OncallEscalation Resource

Constructor syntax

Parameters

OncallEscalation Resource Properties

Inputs

Outputs

Look up Existing OncallEscalation Resource

Import

Package Details

On this page

On this page