Docs Packages
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. OncallEscalation
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

grafana.OncallEscalation

Explore with Pulumi AI

grafana logo
Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
pulumiverse/pulumi-grafana

    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,
                     escalation_chain_id: Optional[str] = None,
                     position: Optional[int] = None,
                     action_to_trigger: Optional[str] = None,
                     duration: Optional[int] = 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,
                     persons_to_notifies: Optional[Sequence[str]] = None,
                     persons_to_notify_next_each_times: Optional[Sequence[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 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.

    Example

    The following reference example uses placeholder values for all input properties.

    var oncallEscalationResource = new Grafana.OncallEscalation("oncallEscalationResource", new()
{
    EscalationChainId = "string",
    Position = 0,
    ActionToTrigger = "string",
    Duration = 0,
    GroupToNotify = "string",
    Important = false,
    NotifyIfTimeFrom = "string",
    NotifyIfTimeTo = "string",
    NotifyOnCallFromSchedule = "string",
    PersonsToNotifies = new[]
    {
        "string",
    },
    PersonsToNotifyNextEachTimes = new[]
    {
        "string",
    },
    Type = "string",
});

    example, err := grafana.NewOncallEscalation(ctx, "oncallEscalationResource", &grafana.OncallEscalationArgs{
	EscalationChainId:        pulumi.String("string"),
	Position:                 pulumi.Int(0),
	ActionToTrigger:          pulumi.String("string"),
	Duration:                 pulumi.Int(0),
	GroupToNotify:            pulumi.String("string"),
	Important:                pulumi.Bool(false),
	NotifyIfTimeFrom:         pulumi.String("string"),
	NotifyIfTimeTo:           pulumi.String("string"),
	NotifyOnCallFromSchedule: pulumi.String("string"),
	PersonsToNotifies: pulumi.StringArray{
		pulumi.String("string"),
	},
	PersonsToNotifyNextEachTimes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Type: pulumi.String("string"),
})

    var oncallEscalationResource = new OncallEscalation("oncallEscalationResource", OncallEscalationArgs.builder()        
    .escalationChainId("string")
    .position(0)
    .actionToTrigger("string")
    .duration(0)
    .groupToNotify("string")
    .important(false)
    .notifyIfTimeFrom("string")
    .notifyIfTimeTo("string")
    .notifyOnCallFromSchedule("string")
    .personsToNotifies("string")
    .personsToNotifyNextEachTimes("string")
    .type("string")
    .build());

    oncall_escalation_resource = grafana.OncallEscalation("oncallEscalationResource",
    escalation_chain_id="string",
    position=0,
    action_to_trigger="string",
    duration=0,
    group_to_notify="string",
    important=False,
    notify_if_time_from="string",
    notify_if_time_to="string",
    notify_on_call_from_schedule="string",
    persons_to_notifies=["string"],
    persons_to_notify_next_each_times=["string"],
    type="string")

    const oncallEscalationResource = new grafana.OncallEscalation("oncallEscalationResource", {
    escalationChainId: "string",
    position: 0,
    actionToTrigger: "string",
    duration: 0,
    groupToNotify: "string",
    important: false,
    notifyIfTimeFrom: "string",
    notifyIfTimeTo: "string",
    notifyOnCallFromSchedule: "string",
    personsToNotifies: ["string"],
    personsToNotifyNextEachTimes: ["string"],
    type: "string",
});

    type: grafana:OncallEscalation
properties:
    actionToTrigger: string
    duration: 0
    escalationChainId: string
    groupToNotify: string
    important: false
    notifyIfTimeFrom: string
    notifyIfTimeTo: string
    notifyOnCallFromSchedule: string
    personsToNotifies:
        - string
    personsToNotifyNextEachTimes:
        - string
    position: 0
    type: string

    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

    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).
    ActionToTrigger string
    The ID of an Action for trigger_action type step.
    Duration int
    The duration of delay for wait type step.
    GroupToNotify string
    The ID of a User Group for notify_user_group type step.
    Important bool
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    NotifyIfTimeFrom string
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    NotifyIfTimeTo string
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    NotifyOnCallFromSchedule string
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    Type string
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    EscalationChainId string
    The ID of the escalation chain.
    Position int
    The position of the escalation step (starts from 0).
    ActionToTrigger string
    The ID of an Action for trigger_action type step.
    Duration int
    The duration of delay for wait type step.
    GroupToNotify string
    The ID of a User Group for notify_user_group type step.
    Important bool
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    NotifyIfTimeFrom string
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    NotifyIfTimeTo string
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    NotifyOnCallFromSchedule string
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    Type string
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    escalationChainId String
    The ID of the escalation chain.
    position Integer
    The position of the escalation step (starts from 0).
    actionToTrigger String
    The ID of an Action for trigger_action type step.
    duration Integer
    The duration of delay for wait type step.
    groupToNotify String
    The ID of a User Group for notify_user_group type step.
    important Boolean
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notifyIfTimeFrom String
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notifyIfTimeTo String
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notifyOnCallFromSchedule String
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    type String
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    escalationChainId string
    The ID of the escalation chain.
    position number
    The position of the escalation step (starts from 0).
    actionToTrigger string
    The ID of an Action for trigger_action type step.
    duration number
    The duration of delay for wait type step.
    groupToNotify string
    The ID of a User Group for notify_user_group type step.
    important boolean
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notifyIfTimeFrom string
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notifyIfTimeTo string
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notifyOnCallFromSchedule string
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    type string
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    escalation_chain_id str
    The ID of the escalation chain.
    position int
    The position of the escalation step (starts from 0).
    action_to_trigger str
    The ID of an Action for trigger_action type step.
    duration int
    The duration of delay for wait type step.
    group_to_notify str
    The ID of a User Group for notify_user_group type step.
    important bool
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notify_if_time_from str
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notify_if_time_to str
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notify_on_call_from_schedule str
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    type str
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    escalationChainId String
    The ID of the escalation chain.
    position Number
    The position of the escalation step (starts from 0).
    actionToTrigger String
    The ID of an Action for trigger_action type step.
    duration Number
    The duration of delay for wait type step.
    groupToNotify String
    The ID of a User Group for notify_user_group type step.
    important Boolean
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notifyIfTimeFrom String
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notifyIfTimeTo String
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notifyOnCallFromSchedule String
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    type String
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation

    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,
        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_action 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 notify_user_group type step.
    Important bool
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    NotifyIfTimeFrom string
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    NotifyIfTimeTo string
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    NotifyOnCallFromSchedule string
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    Position int
    The position of the escalation step (starts from 0).
    Type string
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    ActionToTrigger string
    The ID of an Action for trigger_action 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 notify_user_group type step.
    Important bool
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    NotifyIfTimeFrom string
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    NotifyIfTimeTo string
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    NotifyOnCallFromSchedule string
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    Position int
    The position of the escalation step (starts from 0).
    Type string
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    actionToTrigger String
    The ID of an Action for trigger_action 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 notify_user_group type step.
    important Boolean
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notifyIfTimeFrom String
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notifyIfTimeTo String
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notifyOnCallFromSchedule String
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    position Integer
    The position of the escalation step (starts from 0).
    type String
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    actionToTrigger string
    The ID of an Action for trigger_action 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 notify_user_group type step.
    important boolean
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notifyIfTimeFrom string
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notifyIfTimeTo string
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notifyOnCallFromSchedule string
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    position number
    The position of the escalation step (starts from 0).
    type string
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    action_to_trigger str
    The ID of an Action for trigger_action 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 notify_user_group type step.
    important bool
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notify_if_time_from str
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notify_if_time_to str
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notify_on_call_from_schedule str
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    position int
    The position of the escalation step (starts from 0).
    type str
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation
    actionToTrigger String
    The ID of an Action for trigger_action 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 notify_user_group type step.
    important Boolean
    Will activate "important" personal notification rules. Actual for steps: notify_persons, notify_on_call_from_schedule and notify_user_group
    notifyIfTimeFrom String
    The beginning of the time interval for notify_if_time_from_to type step in UTC (for example 08:00:00Z).
    notifyIfTimeTo String
    The end of the time interval for notify_if_time_from_to type step in UTC (for example 18:00:00Z).
    notifyOnCallFromSchedule String
    ID of a Schedule for notify_on_call_from_schedule 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 notify_person_next_each_time type step.
    position Number
    The position of the escalation step (starts from 0).
    type String
    The type of escalation policy. Can be wait, notify_persons, notify_person_next_each_time, notify_on_call_from_schedule, trigger_action, notify_user_group, resolve, notify_whole_channel, notify_if_time_from_to, repeat_escalation

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Grafana v0.4.2 published on Monday, Apr 15, 2024 by pulumiverse
    pulumiverse/pulumi-grafana