@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
215 lines (214 loc) • 8.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* * [Official documentation](https://grafana.com/docs/oncall/latest/configure/escalation-chains-and-routes/)
* * [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/escalation_policies/)
*
* ## Import
*
* ```sh
* $ pulumi import grafana:onCall/escalation:Escalation name "{{ id }}"
* ```
*/
export declare class Escalation extends pulumi.CustomResource {
/**
* Get an existing Escalation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EscalationState, opts?: pulumi.CustomResourceOptions): Escalation;
/**
* Returns true if the given object is an instance of Escalation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Escalation;
/**
* The ID of an Action for triggerWebhook type step.
*/
readonly actionToTrigger: pulumi.Output<string | undefined>;
/**
* The duration of delay for wait type step. (60-86400) seconds
*/
readonly duration: pulumi.Output<number | undefined>;
/**
* The ID of the escalation chain.
*/
readonly escalationChainId: pulumi.Output<string>;
/**
* The ID of a User Group for notify*user*group type step.
*/
readonly groupToNotify: pulumi.Output<string | undefined>;
/**
* Will activate "important" personal notification rules. Actual for steps: notify*persons, notify*person*next*each*time, notify*on*call*from*schedule, notify*user*group and notify*team_members
*/
readonly important: pulumi.Output<boolean | undefined>;
/**
* The beginning of the time interval for notify*if*time*from*to type step in UTC (for example 08:00:00Z).
*/
readonly notifyIfTimeFrom: pulumi.Output<string | undefined>;
/**
* The end of the time interval for notify*if*time*from*to type step in UTC (for example 18:00:00Z).
*/
readonly notifyIfTimeTo: pulumi.Output<string | undefined>;
/**
* ID of a Schedule for notify*on*call*from*schedule type step.
*/
readonly notifyOnCallFromSchedule: pulumi.Output<string | undefined>;
/**
* The ID of a Team for a notify*team*members type step.
*/
readonly notifyToTeamMembers: pulumi.Output<string | undefined>;
/**
* The list of ID's of users for notifyPersons type step.
*/
readonly personsToNotifies: pulumi.Output<string[] | undefined>;
/**
* The list of ID's of users for notify*person*next*each*time type step.
*/
readonly personsToNotifyNextEachTimes: pulumi.Output<string[] | undefined>;
/**
* The position of the escalation step (starts from 0).
*/
readonly position: pulumi.Output<number>;
/**
* The severity of the incident for declareIncident type step.
*/
readonly severity: pulumi.Output<string | undefined>;
/**
* The type of escalation policy. Can be wait, notify*persons, notify*person*next*each*time, notify*on*call*from*schedule, trigger*webhook, notify*user*group, resolve, notify*whole*channel, notify*if*time*from*to, repeat*escalation, notify*team*members, declare*incident
*/
readonly type: pulumi.Output<string>;
/**
* Create a Escalation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: EscalationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Escalation resources.
*/
export interface EscalationState {
/**
* The ID of an Action for triggerWebhook type step.
*/
actionToTrigger?: pulumi.Input<string>;
/**
* The duration of delay for wait type step. (60-86400) seconds
*/
duration?: pulumi.Input<number>;
/**
* The ID of the escalation chain.
*/
escalationChainId?: pulumi.Input<string>;
/**
* The ID of a User Group for notify*user*group type step.
*/
groupToNotify?: pulumi.Input<string>;
/**
* Will activate "important" personal notification rules. Actual for steps: notify*persons, notify*person*next*each*time, notify*on*call*from*schedule, notify*user*group and notify*team_members
*/
important?: pulumi.Input<boolean>;
/**
* The beginning of the time interval for notify*if*time*from*to type step in UTC (for example 08:00:00Z).
*/
notifyIfTimeFrom?: pulumi.Input<string>;
/**
* The end of the time interval for notify*if*time*from*to type step in UTC (for example 18:00:00Z).
*/
notifyIfTimeTo?: pulumi.Input<string>;
/**
* ID of a Schedule for notify*on*call*from*schedule type step.
*/
notifyOnCallFromSchedule?: pulumi.Input<string>;
/**
* The ID of a Team for a notify*team*members type step.
*/
notifyToTeamMembers?: pulumi.Input<string>;
/**
* The list of ID's of users for notifyPersons type step.
*/
personsToNotifies?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The list of ID's of users for notify*person*next*each*time type step.
*/
personsToNotifyNextEachTimes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The position of the escalation step (starts from 0).
*/
position?: pulumi.Input<number>;
/**
* The severity of the incident for declareIncident type step.
*/
severity?: pulumi.Input<string>;
/**
* The type of escalation policy. Can be wait, notify*persons, notify*person*next*each*time, notify*on*call*from*schedule, trigger*webhook, notify*user*group, resolve, notify*whole*channel, notify*if*time*from*to, repeat*escalation, notify*team*members, declare*incident
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Escalation resource.
*/
export interface EscalationArgs {
/**
* The ID of an Action for triggerWebhook type step.
*/
actionToTrigger?: pulumi.Input<string>;
/**
* The duration of delay for wait type step. (60-86400) seconds
*/
duration?: pulumi.Input<number>;
/**
* The ID of the escalation chain.
*/
escalationChainId: pulumi.Input<string>;
/**
* The ID of a User Group for notify*user*group type step.
*/
groupToNotify?: pulumi.Input<string>;
/**
* Will activate "important" personal notification rules. Actual for steps: notify*persons, notify*person*next*each*time, notify*on*call*from*schedule, notify*user*group and notify*team_members
*/
important?: pulumi.Input<boolean>;
/**
* The beginning of the time interval for notify*if*time*from*to type step in UTC (for example 08:00:00Z).
*/
notifyIfTimeFrom?: pulumi.Input<string>;
/**
* The end of the time interval for notify*if*time*from*to type step in UTC (for example 18:00:00Z).
*/
notifyIfTimeTo?: pulumi.Input<string>;
/**
* ID of a Schedule for notify*on*call*from*schedule type step.
*/
notifyOnCallFromSchedule?: pulumi.Input<string>;
/**
* The ID of a Team for a notify*team*members type step.
*/
notifyToTeamMembers?: pulumi.Input<string>;
/**
* The list of ID's of users for notifyPersons type step.
*/
personsToNotifies?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The list of ID's of users for notify*person*next*each*time type step.
*/
personsToNotifyNextEachTimes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The position of the escalation step (starts from 0).
*/
position: pulumi.Input<number>;
/**
* The severity of the incident for declareIncident type step.
*/
severity?: pulumi.Input<string>;
/**
* The type of escalation policy. Can be wait, notify*persons, notify*person*next*each*time, notify*on*call*from*schedule, trigger*webhook, notify*user*group, resolve, notify*whole*channel, notify*if*time*from*to, repeat*escalation, notify*team*members, declare*incident
*/
type: pulumi.Input<string>;
}