@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
95 lines • 3.44 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.Dashboard = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../../utilities");
/**
* Manages Grafana dashboards using the v2beta1 (Dynamic Dashboards) schema.
*
* * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/)
* * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard/#new-dashboard-apis)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const example = new grafana.apps.v2beta1.Dashboard("example", {
* metadata: {
* uid: "example-dashboard-v2",
* },
* spec: {
* title: "Example Dashboard V2",
* json: JSON.stringify({
* title: "Example Dashboard V2",
* cursorSync: "Off",
* elements: {},
* layout: {
* kind: "GridLayout",
* spec: {
* items: [],
* },
* },
* links: [],
* preload: false,
* annotations: [],
* variables: [],
* timeSettings: {
* timezone: "browser",
* from: "now-6h",
* to: "now",
* },
* }),
* },
* });
* ```
*/
class Dashboard extends pulumi.CustomResource {
/**
* Get an existing Dashboard 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 Dashboard(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Dashboard. 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'] === Dashboard.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["metadata"] = state?.metadata;
resourceInputs["options"] = state?.options;
resourceInputs["spec"] = state?.spec;
}
else {
const args = argsOrState;
resourceInputs["metadata"] = args?.metadata;
resourceInputs["options"] = args?.options;
resourceInputs["spec"] = args?.spec;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(Dashboard.__pulumiType, name, resourceInputs, opts);
}
}
exports.Dashboard = Dashboard;
/** @internal */
Dashboard.__pulumiType = 'grafana:apps/v2beta1/dashboard:Dashboard';
//# sourceMappingURL=dashboard.js.map