@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
101 lines • 3.66 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.Query = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../../utilities");
/**
* Manages Grafana Saved Queries, also known as the Query Library, using the Grafana App Platform API (`queries.grafana.app/v1`).
*
* The datasource query stored in each target, the target's variable replacements, and a variable's value list definition are passed as raw JSON strings (use `jsonencode()`) because their shape depends on the datasource.
*
* * [Query Library documentation](https://grafana.com/docs/grafana/latest/explore/query-management/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const example = new grafana.apps.v1.Query("example", {
* metadata: {
* uid: "example-saved-query",
* },
* spec: {
* title: "Requests per second",
* description: "Prometheus rate of HTTP requests",
* isVisible: true,
* tags: [
* "http",
* "prometheus",
* ],
* targets: [{
* propertiesJson: JSON.stringify({
* refId: "A",
* expr: "rate(http_requests_total[$__rate_interval])",
* datasource: {
* type: "prometheus",
* uid: "my-prometheus-uid",
* },
* }),
* }],
* },
* });
* ```
*
* ## Import
*
* !/bin/bash
* Import an existing saved query by its UID
*
* ```sh
* $ pulumi import grafana:apps/v1/query:Query example example-saved-query
* ```
*/
class Query extends pulumi.CustomResource {
/**
* Get an existing Query 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 Query(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of Query. 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'] === Query.__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(Query.__pulumiType, name, resourceInputs, opts);
}
}
exports.Query = Query;
/** @internal */
Query.__pulumiType = 'grafana:apps/v1/query:Query';
//# sourceMappingURL=query.js.map