@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
133 lines • 5.9 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.DashboardPublic = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Manages Grafana public dashboards.
*
* **Note:** This resource is available only with Grafana 10.2+.
*
* * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/share-dashboards-panels/shared-dashboards/)
* * [HTTP API](https://grafana.com/docs/grafana/next/developers/http_api/dashboard_public/)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* // Optional (On-premise, not supported in Grafana Cloud): Create an organization
* const myOrg = new grafana.oss.Organization("my_org", {name: "test 1"});
* // Create resources (optional: within the organization)
* const myFolder = new grafana.oss.Folder("my_folder", {
* orgId: myOrg.orgId,
* title: "test Folder",
* });
* const testDash = new grafana.oss.Dashboard("test_dash", {
* orgId: myOrg.orgId,
* folder: myFolder.id,
* configJson: JSON.stringify({
* title: "My Terraform Dashboard",
* uid: "my-dashboard-uid",
* }),
* });
* const myPublicDashboard = new grafana.oss.DashboardPublic("my_public_dashboard", {
* orgId: myOrg.orgId,
* dashboardUid: testDash.uid,
* uid: "my-custom-public-uid",
* accessToken: "e99e4275da6f410d83760eefa934d8d2",
* timeSelectionEnabled: true,
* isEnabled: true,
* annotationsEnabled: true,
* share: "public",
* });
* // Optional (On-premise, not supported in Grafana Cloud): Create an organization
* const myOrg2 = new grafana.oss.Organization("my_org2", {name: "test 2"});
* const testDash2 = new grafana.oss.Dashboard("test_dash2", {
* orgId: myOrg2.orgId,
* configJson: JSON.stringify({
* title: "My Terraform Dashboard2",
* uid: "my-dashboard-uid2",
* }),
* });
* const myPublicDashboard2 = new grafana.oss.DashboardPublic("my_public_dashboard2", {
* orgId: myOrg2.orgId,
* dashboardUid: testDash2.uid,
* share: "public",
* });
* ```
*
* ## Import
*
* ```sh
* $ pulumi import grafana:oss/dashboardPublic:DashboardPublic name "{{ dashboardUID }}:{{ publicDashboardUID }}"
* ```
*
* ```sh
* $ pulumi import grafana:oss/dashboardPublic:DashboardPublic name "{{ orgID }}:{{ dashboardUID }}:{{ publicDashboardUID }}"
* ```
*/
class DashboardPublic extends pulumi.CustomResource {
/**
* Get an existing DashboardPublic 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 DashboardPublic(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of DashboardPublic. 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'] === DashboardPublic.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessToken"] = state ? state.accessToken : undefined;
resourceInputs["annotationsEnabled"] = state ? state.annotationsEnabled : undefined;
resourceInputs["dashboardUid"] = state ? state.dashboardUid : undefined;
resourceInputs["isEnabled"] = state ? state.isEnabled : undefined;
resourceInputs["orgId"] = state ? state.orgId : undefined;
resourceInputs["share"] = state ? state.share : undefined;
resourceInputs["timeSelectionEnabled"] = state ? state.timeSelectionEnabled : undefined;
resourceInputs["uid"] = state ? state.uid : undefined;
}
else {
const args = argsOrState;
if ((!args || args.dashboardUid === undefined) && !opts.urn) {
throw new Error("Missing required property 'dashboardUid'");
}
resourceInputs["accessToken"] = args ? args.accessToken : undefined;
resourceInputs["annotationsEnabled"] = args ? args.annotationsEnabled : undefined;
resourceInputs["dashboardUid"] = args ? args.dashboardUid : undefined;
resourceInputs["isEnabled"] = args ? args.isEnabled : undefined;
resourceInputs["orgId"] = args ? args.orgId : undefined;
resourceInputs["share"] = args ? args.share : undefined;
resourceInputs["timeSelectionEnabled"] = args ? args.timeSelectionEnabled : undefined;
resourceInputs["uid"] = args ? args.uid : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "grafana:index/dashboardPublic:DashboardPublic" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(DashboardPublic.__pulumiType, name, resourceInputs, opts);
}
}
exports.DashboardPublic = DashboardPublic;
/** @internal */
DashboardPublic.__pulumiType = 'grafana:oss/dashboardPublic:DashboardPublic';
//# sourceMappingURL=dashboardPublic.js.map