1. Packages
  2. Grafana Cloud
  3. API Docs
  4. OncallEscalation
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

grafana.OncallEscalation

Explore with Pulumi AI

grafana logo
Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as grafana from "@pulumi/grafana";
    import * as grafana from "@pulumiverse/grafana";
    
    const _default = new grafana.OncallEscalationChain("default", {}, {
        provider: grafana.oncall,
    });
    const alex = grafana.getOncallUser({
        username: "alex",
    });
    // Notify step
    const exampleNotifyStepOncallEscalation = new grafana.OncallEscalation("exampleNotifyStepOncallEscalation", {
        escalationChainId: _default.id,
        type: "notify_persons",
        personsToNotifies: [alex.then(alex => alex.id)],
        position: 0,
    });
    // Wait step
    const exampleNotifyStepIndex_oncallEscalationOncallEscalation = new grafana.OncallEscalation("exampleNotifyStepIndex/oncallEscalationOncallEscalation", {
        escalationChainId: _default.id,
        type: "wait",
        duration: 300,
        position: 1,
    });
    // Important step
    const exampleNotifyStepGrafanaIndex_oncallEscalationOncallEscalation = new grafana.OncallEscalation("exampleNotifyStepGrafanaIndex/oncallEscalationOncallEscalation", {
        escalationChainId: _default.id,
        type: "notify_persons",
        important: true,
        personsToNotifies: [alex.then(alex => alex.id)],
        position: 0,
    });
    
    import pulumi
    import pulumi_grafana as grafana
    import pulumiverse_grafana as grafana
    
    default = grafana.OncallEscalationChain("default", opts=pulumi.ResourceOptions(provider=grafana["oncall"]))
    alex = grafana.get_oncall_user(username="alex")
    # Notify step
    example_notify_step_oncall_escalation = grafana.OncallEscalation("exampleNotifyStepOncallEscalation",
        escalation_chain_id=default.id,
        type="notify_persons",
        persons_to_notifies=[alex.id],
        position=0)
    # Wait step
    example_notify_step_index_oncall_escalation_oncall_escalation = grafana.OncallEscalation("exampleNotifyStepIndex/oncallEscalationOncallEscalation",
        escalation_chain_id=default.id,
        type="wait",
        duration=300,
        position=1)
    # Important step
    example_notify_step_grafana_index_oncall_escalation_oncall_escalation = grafana.OncallEscalation("exampleNotifyStepGrafanaIndex/oncallEscalationOncallEscalation",
        escalation_chain_id=default.id,
        type="notify_persons",
        important=True,
        persons_to_notifies=[alex.id],
        position=0)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := grafana.NewOncallEscalationChain(ctx, "default", nil, pulumi.Provider(grafana.Oncall))
    		if err != nil {
    			return err
    		}
    		alex, err := grafana.GetOncallUser(ctx, &grafana.GetOncallUserArgs{
    			Username: "alex",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Notify step
    		_, err = grafana.NewOncallEscalation(ctx, "exampleNotifyStepOncallEscalation", &grafana.OncallEscalationArgs{
    			EscalationChainId: _default.ID(),
    			Type:              pulumi.String("notify_persons"),
    			PersonsToNotifies: pulumi.StringArray{
    				pulumi.String(alex.Id),
    			},
    			Position: pulumi.Int(0),
    		})
    		if err != nil {
    			return err
    		}
    		// Wait step
    		_, err = grafana.NewOncallEscalation(ctx, "exampleNotifyStepIndex/oncallEscalationOncallEscalation", &grafana.OncallEscalationArgs{
    			EscalationChainId: _default.ID(),
    			Type:              pulumi.String("wait"),
    			Duration:          pulumi.Int(300),
    			Position:          pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		// Important step
    		_, err = grafana.NewOncallEscalation(ctx, "exampleNotifyStepGrafanaIndex/oncallEscalationOncallEscalation", &grafana.OncallEscalationArgs{
    			EscalationChainId: _default.ID(),
    			Type:              pulumi.String("notify_persons"),
    			Important:         pulumi.Bool(true),
    			PersonsToNotifies: pulumi.StringArray{
    				pulumi.String(alex.Id),
    			},
    			Position: pulumi.Int(0),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Grafana = Pulumi.Grafana;
    using Grafana = Pulumiverse.Grafana;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Grafana.OncallEscalationChain("default", new()
        {
        }, new CustomResourceOptions
        {
            Provider = grafana.Oncall,
        });
    
        var alex = Grafana.GetOncallUser.Invoke(new()
        {
            Username = "alex",
        });
    
        // Notify step
        var exampleNotifyStepOncallEscalation = new Grafana.OncallEscalation("exampleNotifyStepOncallEscalation", new()
        {
            EscalationChainId = @default.Id,
            Type = "notify_persons",
            PersonsToNotifies = new[]
            {
                alex.Apply(getOncallUserResult => getOncallUserResult.Id),
            },
            Position = 0,
        });
    
        // Wait step
        var exampleNotifyStepIndex_oncallEscalationOncallEscalation = new Grafana.OncallEscalation("exampleNotifyStepIndex/oncallEscalationOncallEscalation", new()
        {
            EscalationChainId = @default.Id,
            Type = "wait",
            Duration = 300,
            Position = 1,
        });
    
        // Important step
        var exampleNotifyStepGrafanaIndex_oncallEscalationOncallEscalation = new Grafana.OncallEscalation("exampleNotifyStepGrafanaIndex/oncallEscalationOncallEscalation", new()
        {
            EscalationChainId = @default.Id,
            Type = "notify_persons",
            Important = true,
            PersonsToNotifies = new[]
            {
                alex.Apply(getOncallUserResult => getOncallUserResult.Id),
            },
            Position = 0,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.grafana.OncallEscalationChain;
    import com.pulumi.grafana.OncallEscalationChainArgs;
    import com.pulumi.grafana.GrafanaFunctions;
    import com.pulumi.grafana.inputs.GetOncallUserArgs;
    import com.pulumi.grafana.OncallEscalation;
    import com.pulumi.grafana.OncallEscalationArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var default_ = new OncallEscalationChain("default", OncallEscalationChainArgs.Empty, CustomResourceOptions.builder()
                .provider(grafana.oncall())
                .build());
    
            final var alex = GrafanaFunctions.getOncallUser(GetOncallUserArgs.builder()
                .username("alex")
                .build());
    
            // Notify step
            var exampleNotifyStepOncallEscalation = new OncallEscalation("exampleNotifyStepOncallEscalation", OncallEscalationArgs.builder()        
                .escalationChainId(default_.id())
                .type("notify_persons")
                .personsToNotifies(alex.applyValue(getOncallUserResult -> getOncallUserResult.id()))
                .position(0)
                .build());
    
            // Wait step
            var exampleNotifyStepIndex_oncallEscalationOncallEscalation = new OncallEscalation("exampleNotifyStepIndex/oncallEscalationOncallEscalation", OncallEscalationArgs.builder()        
                .escalationChainId(default_.id())
                .type("wait")
                .duration(300)
                .position(1)
                .build());
    
            // Important step
            var exampleNotifyStepGrafanaIndex_oncallEscalationOncallEscalation = new OncallEscalation("exampleNotifyStepGrafanaIndex/oncallEscalationOncallEscalation", OncallEscalationArgs.builder()        
                .escalationChainId(default_.id())
                .type("notify_persons")
                .important(true)
                .personsToNotifies(alex.applyValue(getOncallUserResult -> getOncallUserResult.id()))
                .position(0)
                .build());
    
        }
    }
    
    resources:
      default:
        type: grafana:OncallEscalationChain
        options:
          provider: ${grafana.oncall}
      # Notify step
      exampleNotifyStepOncallEscalation:
        type: grafana:OncallEscalation
        properties:
          escalationChainId: ${default.id}
          type: notify_persons
          personsToNotifies:
            - ${alex.id}
          position: 0
      # Wait step
      exampleNotifyStepIndex/oncallEscalationOncallEscalation:
        type: grafana:OncallEscalation
        properties:
          escalationChainId: ${default.id}
          type: wait
          duration: 300
          position: 1
      # Important step
      exampleNotifyStepGrafanaIndex/oncallEscalationOncallEscalation:
        type: grafana:OncallEscalation
        properties:
          escalationChainId: ${default.id}
          type: notify_persons
          important: true
          personsToNotifies:
            - ${alex.id}
          position: 0
    variables:
      alex:
        fn::invoke:
          Function: grafana:getOncallUser
          Arguments:
            username: alex
    

    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,
                         position: Optional[int] = None,
                         type: Optional[str] = None,
                         escalation_chain_id: Optional[str] = None,
                         notify_if_time_to: Optional[str] = None,
                         important: Optional[bool] = None,
                         notify_if_time_from: Optional[str] = None,
                         action_to_trigger: 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,
                         group_to_notify: Optional[str] = None,
                         duration: Optional[int] = 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.

    Constructor example

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

    var oncallEscalationResource = new Grafana.OncallEscalation("oncallEscalationResource", new()
    {
        Position = 0,
        Type = "string",
        EscalationChainId = "string",
        NotifyIfTimeTo = "string",
        Important = false,
        NotifyIfTimeFrom = "string",
        ActionToTrigger = "string",
        NotifyOnCallFromSchedule = "string",
        NotifyToTeamMembers = "string",
        PersonsToNotifies = new[]
        {
            "string",
        },
        PersonsToNotifyNextEachTimes = new[]
        {
            "string",
        },
        GroupToNotify = "string",
        Duration = 0,
    });
    
    example, err := grafana.NewOncallEscalation(ctx, "oncallEscalationResource", &grafana.OncallEscalationArgs{
    	Position:                 pulumi.Int(0),
    	Type:                     pulumi.String("string"),
    	EscalationChainId:        pulumi.String("string"),
    	NotifyIfTimeTo:           pulumi.String("string"),
    	Important:                pulumi.Bool(false),
    	NotifyIfTimeFrom:         pulumi.String("string"),
    	ActionToTrigger:          pulumi.String("string"),
    	NotifyOnCallFromSchedule: pulumi.String("string"),
    	NotifyToTeamMembers:      pulumi.String("string"),
    	PersonsToNotifies: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PersonsToNotifyNextEachTimes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	GroupToNotify: pulumi.String("string"),
    	Duration:      pulumi.Int(0),
    })
    
    var oncallEscalationResource = new OncallEscalation("oncallEscalationResource", OncallEscalationArgs.builder()
        .position(0)
        .type("string")
        .escalationChainId("string")
        .notifyIfTimeTo("string")
        .important(false)
        .notifyIfTimeFrom("string")
        .actionToTrigger("string")
        .notifyOnCallFromSchedule("string")
        .notifyToTeamMembers("string")
        .personsToNotifies("string")
        .personsToNotifyNextEachTimes("string")
        .groupToNotify("string")
        .duration(0)
        .build());
    
    oncall_escalation_resource = grafana.OncallEscalation("oncallEscalationResource",
        position=0,
        type="string",
        escalation_chain_id="string",
        notify_if_time_to="string",
        important=False,
        notify_if_time_from="string",
        action_to_trigger="string",
        notify_on_call_from_schedule="string",
        notify_to_team_members="string",
        persons_to_notifies=["string"],
        persons_to_notify_next_each_times=["string"],
        group_to_notify="string",
        duration=0)
    
    const oncallEscalationResource = new grafana.OncallEscalation("oncallEscalationResource", {
        position: 0,
        type: "string",
        escalationChainId: "string",
        notifyIfTimeTo: "string",
        important: false,
        notifyIfTimeFrom: "string",
        actionToTrigger: "string",
        notifyOnCallFromSchedule: "string",
        notifyToTeamMembers: "string",
        personsToNotifies: ["string"],
        personsToNotifyNextEachTimes: ["string"],
        groupToNotify: "string",
        duration: 0,
    });
    
    type: grafana:OncallEscalation
    properties:
        actionToTrigger: string
        duration: 0
        escalationChainId: string
        groupToNotify: string
        important: false
        notifyIfTimeFrom: string
        notifyIfTimeTo: string
        notifyOnCallFromSchedule: string
        notifyToTeamMembers: 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).
    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 logo
    Grafana v0.5.1 published on Wednesday, Jun 12, 2024 by pulumiverse