@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
112 lines • 4.44 kB
JavaScript
;
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Holiday = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* 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
* $ pulumi import grafana:machineLearning/holiday:Holiday name "{{ id }}"
* ```
*/
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, id, state, opts) {
return new Holiday(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Holiday.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["customPeriods"] = state ? state.customPeriods : undefined;
resourceInputs["description"] = state ? state.description : undefined;
resourceInputs["icalTimezone"] = state ? state.icalTimezone : undefined;
resourceInputs["icalUrl"] = state ? state.icalUrl : undefined;
resourceInputs["name"] = state ? state.name : undefined;
}
else {
const args = argsOrState;
resourceInputs["customPeriods"] = args ? args.customPeriods : undefined;
resourceInputs["description"] = args ? args.description : undefined;
resourceInputs["icalTimezone"] = args ? args.icalTimezone : undefined;
resourceInputs["icalUrl"] = args ? args.icalUrl : undefined;
resourceInputs["name"] = args ? args.name : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "grafana:index/machineLearningHoliday:MachineLearningHoliday" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(Holiday.__pulumiType, name, resourceInputs, opts);
}
}
exports.Holiday = Holiday;
/** @internal */
Holiday.__pulumiType = 'grafana:machineLearning/holiday:Holiday';
//# sourceMappingURL=holiday.js.map