@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
253 lines (252 loc) • 9.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* * [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/on_call_shifts/)
*
* ## Import
*
* ```sh
* $ pulumi import grafana:index/oncallOnCallShift:OncallOnCallShift name "{{ id }}"
* ```
*
* @deprecated grafana.index/oncalloncallshift.OncallOnCallShift has been deprecated in favor of grafana.oncall/oncallshift.OnCallShift
*/
export declare class OncallOnCallShift extends pulumi.CustomResource {
/**
* Get an existing OncallOnCallShift 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?: OncallOnCallShiftState, opts?: pulumi.CustomResourceOptions): OncallOnCallShift;
/**
* Returns true if the given object is an instance of OncallOnCallShift. 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 OncallOnCallShift;
/**
* This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
*/
readonly byDays: pulumi.Output<string[] | undefined>;
/**
* This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
*/
readonly byMonthdays: pulumi.Output<number[] | undefined>;
/**
* This parameter takes a list of months. Valid values are 1 to 12
*/
readonly byMonths: pulumi.Output<number[] | undefined>;
/**
* The duration of the event.
*/
readonly duration: pulumi.Output<number>;
/**
* The frequency of the event. Can be hourly, daily, weekly, monthly
*/
readonly frequency: pulumi.Output<string | undefined>;
/**
* The positive integer representing at which intervals the recurrence rule repeats.
*/
readonly interval: pulumi.Output<number | undefined>;
/**
* The priority level. The higher the value, the higher the priority.
*/
readonly level: pulumi.Output<number | undefined>;
/**
* The shift's name.
*/
readonly name: pulumi.Output<string>;
/**
* The list of lists with on-call users (for rollingUsers event type)
*/
readonly rollingUsers: pulumi.Output<string[][] | undefined>;
/**
* The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
*/
readonly start: pulumi.Output<string>;
/**
* The index of the list of users in rolling_users, from which on-call rotation starts.
*/
readonly startRotationFromUserIndex: pulumi.Output<number | undefined>;
/**
* The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana.onCall.getTeam` datasource.
*/
readonly teamId: pulumi.Output<string | undefined>;
/**
* The shift's timezone. Overrides schedule's timezone.
*/
readonly timeZone: pulumi.Output<string | undefined>;
/**
* The shift's type. Can be rolling*users, recurrent*event, single_event
*/
readonly type: pulumi.Output<string>;
/**
* The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
*/
readonly until: pulumi.Output<string | undefined>;
/**
* The list of on-call users (for single*event and recurrent*event event type).
*/
readonly users: pulumi.Output<string[] | undefined>;
/**
* Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
*/
readonly weekStart: pulumi.Output<string | undefined>;
/**
* Create a OncallOnCallShift 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.
*/
/** @deprecated grafana.index/oncalloncallshift.OncallOnCallShift has been deprecated in favor of grafana.oncall/oncallshift.OnCallShift */
constructor(name: string, args: OncallOnCallShiftArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OncallOnCallShift resources.
*/
export interface OncallOnCallShiftState {
/**
* This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
*/
byDays?: pulumi.Input<pulumi.Input<string>[]>;
/**
* This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
*/
byMonthdays?: pulumi.Input<pulumi.Input<number>[]>;
/**
* This parameter takes a list of months. Valid values are 1 to 12
*/
byMonths?: pulumi.Input<pulumi.Input<number>[]>;
/**
* The duration of the event.
*/
duration?: pulumi.Input<number>;
/**
* The frequency of the event. Can be hourly, daily, weekly, monthly
*/
frequency?: pulumi.Input<string>;
/**
* The positive integer representing at which intervals the recurrence rule repeats.
*/
interval?: pulumi.Input<number>;
/**
* The priority level. The higher the value, the higher the priority.
*/
level?: pulumi.Input<number>;
/**
* The shift's name.
*/
name?: pulumi.Input<string>;
/**
* The list of lists with on-call users (for rollingUsers event type)
*/
rollingUsers?: pulumi.Input<pulumi.Input<pulumi.Input<string>[]>[]>;
/**
* The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
*/
start?: pulumi.Input<string>;
/**
* The index of the list of users in rolling_users, from which on-call rotation starts.
*/
startRotationFromUserIndex?: pulumi.Input<number>;
/**
* The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana.onCall.getTeam` datasource.
*/
teamId?: pulumi.Input<string>;
/**
* The shift's timezone. Overrides schedule's timezone.
*/
timeZone?: pulumi.Input<string>;
/**
* The shift's type. Can be rolling*users, recurrent*event, single_event
*/
type?: pulumi.Input<string>;
/**
* The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
*/
until?: pulumi.Input<string>;
/**
* The list of on-call users (for single*event and recurrent*event event type).
*/
users?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
*/
weekStart?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a OncallOnCallShift resource.
*/
export interface OncallOnCallShiftArgs {
/**
* This parameter takes a list of days in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
*/
byDays?: pulumi.Input<pulumi.Input<string>[]>;
/**
* This parameter takes a list of days of the month. Valid values are 1 to 31 or -31 to -1
*/
byMonthdays?: pulumi.Input<pulumi.Input<number>[]>;
/**
* This parameter takes a list of months. Valid values are 1 to 12
*/
byMonths?: pulumi.Input<pulumi.Input<number>[]>;
/**
* The duration of the event.
*/
duration: pulumi.Input<number>;
/**
* The frequency of the event. Can be hourly, daily, weekly, monthly
*/
frequency?: pulumi.Input<string>;
/**
* The positive integer representing at which intervals the recurrence rule repeats.
*/
interval?: pulumi.Input<number>;
/**
* The priority level. The higher the value, the higher the priority.
*/
level?: pulumi.Input<number>;
/**
* The shift's name.
*/
name?: pulumi.Input<string>;
/**
* The list of lists with on-call users (for rollingUsers event type)
*/
rollingUsers?: pulumi.Input<pulumi.Input<pulumi.Input<string>[]>[]>;
/**
* The start time of the on-call shift. This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
*/
start: pulumi.Input<string>;
/**
* The index of the list of users in rolling_users, from which on-call rotation starts.
*/
startRotationFromUserIndex?: pulumi.Input<number>;
/**
* The ID of the OnCall team. To get one, create a team in Grafana, and navigate to the OnCall plugin (to sync the team with OnCall). You can then get the ID using the `grafana.onCall.getTeam` datasource.
*/
teamId?: pulumi.Input<string>;
/**
* The shift's timezone. Overrides schedule's timezone.
*/
timeZone?: pulumi.Input<string>;
/**
* The shift's type. Can be rolling*users, recurrent*event, single_event
*/
type: pulumi.Input<string>;
/**
* The end time of recurrent on-call shifts (endless if null). This parameter takes a date format as yyyy-MM-dd'T'HH:mm:ss (for example "2020-09-05T08:00:00")
*/
until?: pulumi.Input<string>;
/**
* The list of on-call users (for single*event and recurrent*event event type).
*/
users?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Start day of the week in iCal format. Can be MO, TU, WE, TH, FR, SA, SU
*/
weekStart?: pulumi.Input<string>;
}