@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
106 lines (105 loc) • 3.96 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 new Grafana APIs.
*
* * [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.v1beta1.Dashboard("example", {
* metadata: {
* uid: "example-dashboard",
* },
* spec: {
* title: "Example Dashboard",
* json: JSON.stringify({
* title: "Example Dashboard",
* uid: "example-dashboard",
* panels: [],
* schemaVersion: 42,
* }),
* },
* });
* ```
*
* @deprecated grafana.experimental/appsdashboard.AppsDashboard has been deprecated in favor of grafana.apps/v1beta1/dashboard.Dashboard
*/
export declare class AppsDashboard extends pulumi.CustomResource {
/**
* Get an existing AppsDashboard 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?: AppsDashboardState, opts?: pulumi.CustomResourceOptions): AppsDashboard;
/**
* Returns true if the given object is an instance of AppsDashboard. 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 AppsDashboard;
/**
* The metadata of the resource.
*/
readonly metadata: pulumi.Output<outputs.experimental.AppsDashboardMetadata | undefined>;
/**
* Options for applying the resource.
*/
readonly options: pulumi.Output<outputs.experimental.AppsDashboardOptions | undefined>;
/**
* The spec of the resource.
*/
readonly spec: pulumi.Output<outputs.experimental.AppsDashboardSpec | undefined>;
/**
* Create a AppsDashboard 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.
*/
/** @deprecated grafana.experimental/appsdashboard.AppsDashboard has been deprecated in favor of grafana.apps/v1beta1/dashboard.Dashboard */
constructor(name: string, args?: AppsDashboardArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AppsDashboard resources.
*/
export interface AppsDashboardState {
/**
* The metadata of the resource.
*/
metadata?: pulumi.Input<inputs.experimental.AppsDashboardMetadata>;
/**
* Options for applying the resource.
*/
options?: pulumi.Input<inputs.experimental.AppsDashboardOptions>;
/**
* The spec of the resource.
*/
spec?: pulumi.Input<inputs.experimental.AppsDashboardSpec>;
}
/**
* The set of arguments for constructing a AppsDashboard resource.
*/
export interface AppsDashboardArgs {
/**
* The metadata of the resource.
*/
metadata?: pulumi.Input<inputs.experimental.AppsDashboardMetadata>;
/**
* Options for applying the resource.
*/
options?: pulumi.Input<inputs.experimental.AppsDashboardOptions>;
/**
* The spec of the resource.
*/
spec?: pulumi.Input<inputs.experimental.AppsDashboardSpec>;
}