UNPKG

@lbrlabs/pulumi-grafana

Version:

A Pulumi package for creating and managing grafana.

97 lines 4.08 kB
"use strict"; // *** 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.DashboardPermission = void 0; const pulumi = require("@pulumi/pulumi"); const utilities = require("./utilities"); /** * * [Official documentation](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/) * * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/dashboard_permissions/) * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as fs from "fs"; * import * as grafana from "@lbrlabs/pulumi-grafana"; * * const team = new grafana.Team("team", {}); * const user = new grafana.User("user", {email: "user.name@example.com"}); * const metrics = new grafana.Dashboard("metrics", {configJson: fs.readFileSync("grafana-dashboard.json")}); * const collectionPermission = new grafana.DashboardPermission("collectionPermission", { * dashboardUid: metrics.uid, * permissions: [ * { * role: "Editor", * permission: "Edit", * }, * { * teamId: team.id, * permission: "View", * }, * { * userId: user.id, * permission: "Admin", * }, * ], * }); * ``` * * ## Import * * ```sh * $ pulumi import grafana:index/dashboardPermission:DashboardPermission dashboard_name {{dashboard_uid}} * ``` */ class DashboardPermission extends pulumi.CustomResource { /** * Get an existing DashboardPermission 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 DashboardPermission(name, state, Object.assign(Object.assign({}, opts), { id: id })); } /** * Returns true if the given object is an instance of DashboardPermission. 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'] === DashboardPermission.__pulumiType; } constructor(name, argsOrState, opts) { let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["dashboardId"] = state ? state.dashboardId : undefined; resourceInputs["dashboardUid"] = state ? state.dashboardUid : undefined; resourceInputs["orgId"] = state ? state.orgId : undefined; resourceInputs["permissions"] = state ? state.permissions : undefined; } else { const args = argsOrState; if ((!args || args.permissions === undefined) && !opts.urn) { throw new Error("Missing required property 'permissions'"); } resourceInputs["dashboardId"] = args ? args.dashboardId : undefined; resourceInputs["dashboardUid"] = args ? args.dashboardUid : undefined; resourceInputs["orgId"] = args ? args.orgId : undefined; resourceInputs["permissions"] = args ? args.permissions : undefined; } opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts); super(DashboardPermission.__pulumiType, name, resourceInputs, opts); } } exports.DashboardPermission = DashboardPermission; /** @internal */ DashboardPermission.__pulumiType = 'grafana:index/dashboardPermission:DashboardPermission'; //# sourceMappingURL=dashboardPermission.js.map