@pulumiverse/grafana/machinelearning/holiday.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";
/**
 * A holiday describes time periods where a time series is expected to behave differently to normal.
 *
 * To use a holiday in a job, use its id in the `holidays` attribute of a `grafana.machineLearning.Job`:
 *
 * ### iCal Holiday
 *
 * This holiday uses an iCal file to define the holidays.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as grafana from "@pulumiverse/grafana";
 *
 * const ical = new grafana.machinelearning.Holiday("ical", {
 *     name: "My iCal holiday",
 *     description: "My Holiday",
 *     icalUrl: "https://calendar.google.com/calendar/ical/en.uk%23holiday%40group.v.calendar.google.com/public/basic.ics",
 *     icalTimezone: "Europe/London",
 * });
 * ```
 *
 * ### Custom Periods Holiday
 *
 * This holiday uses custom periods to define the holidays.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as grafana from "@pulumiverse/grafana";
 *
 * const customPeriods = new grafana.machinelearning.Holiday("custom_periods", {
 *     name: "My custom periods holiday",
 *     description: "My Holiday",
 *     customPeriods: [
 *         {
 *             name: "First of January",
 *             startTime: "2023-01-01T00:00:00Z",
 *             endTime: "2023-01-02T00:00:00Z",
 *         },
 *         {
 *             name: "First of Feburary",
 *             startTime: "2023-02-01T00:00:00Z",
 *             endTime: "2023-02-02T00:00:00Z",
 *         },
 *     ],
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * terraform import grafana_machine_learning_holiday.name "{{ id }}"
 * ```
 */
export declare class Holiday extends pulumi.CustomResource {
    /**
     * Get an existing Holiday 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?: HolidayState, opts?: pulumi.CustomResourceOptions): Holiday;
    /**
     * Returns true if the given object is an instance of Holiday.  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 Holiday;
    /**
     * A list of custom periods for the holiday.
     */
    readonly customPeriods: pulumi.Output<outputs.machineLearning.HolidayCustomPeriod[] | undefined>;
    /**
     * A description of the holiday.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The timezone to use for events in the iCal file pointed to by ical_url.
     */
    readonly icalTimezone: pulumi.Output<string | undefined>;
    /**
     * A URL to an iCal file containing all occurrences of the holiday.
     */
    readonly icalUrl: pulumi.Output<string | undefined>;
    /**
     * The name of the holiday.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Create a Holiday 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?: HolidayArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Holiday resources.
 */
export interface HolidayState {
    /**
     * A list of custom periods for the holiday.
     */
    customPeriods?: pulumi.Input<pulumi.Input<inputs.machineLearning.HolidayCustomPeriod>[]>;
    /**
     * A description of the holiday.
     */
    description?: pulumi.Input<string>;
    /**
     * The timezone to use for events in the iCal file pointed to by ical_url.
     */
    icalTimezone?: pulumi.Input<string>;
    /**
     * A URL to an iCal file containing all occurrences of the holiday.
     */
    icalUrl?: pulumi.Input<string>;
    /**
     * The name of the holiday.
     */
    name?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Holiday resource.
 */
export interface HolidayArgs {
    /**
     * A list of custom periods for the holiday.
     */
    customPeriods?: pulumi.Input<pulumi.Input<inputs.machineLearning.HolidayCustomPeriod>[]>;
    /**
     * A description of the holiday.
     */
    description?: pulumi.Input<string>;
    /**
     * The timezone to use for events in the iCal file pointed to by ical_url.
     */
    icalTimezone?: pulumi.Input<string>;
    /**
     * A URL to an iCal file containing all occurrences of the holiday.
     */
    icalUrl?: pulumi.Input<string>;
    /**
     * The name of the holiday.
     */
    name?: pulumi.Input<string>;
}