@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
117 lines (116 loc) • 4.02 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* 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",
* },
* }),
* },
* });
* ```
*/
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard;
/**
* 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: any): obj is Dashboard;
/**
* The metadata of the resource.
*/
readonly metadata: pulumi.Output<outputs.apps.v2beta1.DashboardMetadata | undefined>;
/**
* Options for applying the resource.
*/
readonly options: pulumi.Output<outputs.apps.v2beta1.DashboardOptions | undefined>;
/**
* The spec of the resource.
*/
readonly spec: pulumi.Output<outputs.apps.v2beta1.DashboardSpec | undefined>;
/**
* Create a Dashboard 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?: DashboardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Dashboard resources.
*/
export interface DashboardState {
/**
* The metadata of the resource.
*/
metadata?: pulumi.Input<inputs.apps.v2beta1.DashboardMetadata>;
/**
* Options for applying the resource.
*/
options?: pulumi.Input<inputs.apps.v2beta1.DashboardOptions>;
/**
* The spec of the resource.
*/
spec?: pulumi.Input<inputs.apps.v2beta1.DashboardSpec>;
}
/**
* The set of arguments for constructing a Dashboard resource.
*/
export interface DashboardArgs {
/**
* The metadata of the resource.
*/
metadata?: pulumi.Input<inputs.apps.v2beta1.DashboardMetadata>;
/**
* Options for applying the resource.
*/
options?: pulumi.Input<inputs.apps.v2beta1.DashboardOptions>;
/**
* The spec of the resource.
*/
spec?: pulumi.Input<inputs.apps.v2beta1.DashboardSpec>;
}