@pulumiverse/grafana/oncall/schedule.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * * [HTTP API](https://grafana.com/docs/oncall/latest/oncall-api-reference/schedules/)
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import grafana:onCall/schedule:Schedule name "{{ id }}"
 * ```
 */
export declare class Schedule extends pulumi.CustomResource {
    /**
     * Get an existing Schedule 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?: ScheduleState, opts?: pulumi.CustomResourceOptions): Schedule;
    /**
     * Returns true if the given object is an instance of Schedule.  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 Schedule;
    /**
     * Enable overrides via web UI (it will ignore ical*url*overrides).
     */
    readonly enableWebOverrides: pulumi.Output<boolean | undefined>;
    /**
     * The URL of external iCal calendar which override primary events.
     */
    readonly icalUrlOverrides: pulumi.Output<string | undefined>;
    /**
     * The URL of the external calendar iCal file.
     */
    readonly icalUrlPrimary: pulumi.Output<string | undefined>;
    /**
     * The schedule's name.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The list of ID's of on-call shifts.
     */
    readonly shifts: pulumi.Output<string[] | undefined>;
    /**
     * The Slack-specific settings for a schedule.
     */
    readonly slack: pulumi.Output<outputs.onCall.ScheduleSlack | 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 schedule's time zone.
     */
    readonly timeZone: pulumi.Output<string | undefined>;
    /**
     * The schedule's type. Valid values are `ical`, `calendar`.
     */
    readonly type: pulumi.Output<string>;
    /**
     * Create a Schedule 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: ScheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Schedule resources.
 */
export interface ScheduleState {
    /**
     * Enable overrides via web UI (it will ignore ical*url*overrides).
     */
    enableWebOverrides?: pulumi.Input<boolean>;
    /**
     * The URL of external iCal calendar which override primary events.
     */
    icalUrlOverrides?: pulumi.Input<string>;
    /**
     * The URL of the external calendar iCal file.
     */
    icalUrlPrimary?: pulumi.Input<string>;
    /**
     * The schedule's name.
     */
    name?: pulumi.Input<string>;
    /**
     * The list of ID's of on-call shifts.
     */
    shifts?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The Slack-specific settings for a schedule.
     */
    slack?: pulumi.Input<inputs.onCall.ScheduleSlack>;
    /**
     * 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 schedule's time zone.
     */
    timeZone?: pulumi.Input<string>;
    /**
     * The schedule's type. Valid values are `ical`, `calendar`.
     */
    type?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Schedule resource.
 */
export interface ScheduleArgs {
    /**
     * Enable overrides via web UI (it will ignore ical*url*overrides).
     */
    enableWebOverrides?: pulumi.Input<boolean>;
    /**
     * The URL of external iCal calendar which override primary events.
     */
    icalUrlOverrides?: pulumi.Input<string>;
    /**
     * The URL of the external calendar iCal file.
     */
    icalUrlPrimary?: pulumi.Input<string>;
    /**
     * The schedule's name.
     */
    name?: pulumi.Input<string>;
    /**
     * The list of ID's of on-call shifts.
     */
    shifts?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The Slack-specific settings for a schedule.
     */
    slack?: pulumi.Input<inputs.onCall.ScheduleSlack>;
    /**
     * 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 schedule's time zone.
     */
    timeZone?: pulumi.Input<string>;
    /**
     * The schedule's type. Valid values are `ical`, `calendar`.
     */
    type: pulumi.Input<string>;
}