@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
110 lines • 4.72 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.DashboardPermissionItem = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* Manages a single permission item for a dashboard. Conflicts with the "grafana.oss.DashboardPermission" resource which manages the entire set of permissions for a dashboard.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const team = new grafana.oss.Team("team", {name: "Team Name"});
* const user = new grafana.oss.User("user", {
* email: "user.name@example.com",
* password: "my-password",
* login: "user.name",
* });
* const dashboard = new grafana.oss.Dashboard("dashboard", {configJson: JSON.stringify({
* title: "My Dashboard",
* uid: "my-dashboard-uid",
* })});
* const role = new grafana.oss.DashboardPermissionItem("role", {
* dashboardUid: dashboard.uid,
* role: "Viewer",
* permission: "View",
* });
* const userDashboardPermissionItem = new grafana.oss.DashboardPermissionItem("user", {
* dashboardUid: dashboard.uid,
* user: user.id,
* permission: "Admin",
* });
* const teamDashboardPermissionItem = new grafana.oss.DashboardPermissionItem("team", {
* dashboardUid: dashboard.uid,
* team: team.id,
* permission: "Edit",
* });
* ```
*
* ## Import
*
* ```sh
* terraform import grafana_dashboard_permission_item.name "{{ dashboardUID }}:{{ type (role, team, or user) }}:{{ identifier }}"
* terraform import grafana_dashboard_permission_item.name "{{ orgID }}:{{ dashboardUID }}:{{ type (role, team, or user) }}:{{ identifier }}"
* ```
*/
class DashboardPermissionItem extends pulumi.CustomResource {
/**
* Get an existing DashboardPermissionItem 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 DashboardPermissionItem(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of DashboardPermissionItem. 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'] === DashboardPermissionItem.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["dashboardUid"] = state?.dashboardUid;
resourceInputs["orgId"] = state?.orgId;
resourceInputs["permission"] = state?.permission;
resourceInputs["role"] = state?.role;
resourceInputs["team"] = state?.team;
resourceInputs["user"] = state?.user;
}
else {
const args = argsOrState;
if (args?.dashboardUid === undefined && !opts.urn) {
throw new Error("Missing required property 'dashboardUid'");
}
if (args?.permission === undefined && !opts.urn) {
throw new Error("Missing required property 'permission'");
}
resourceInputs["dashboardUid"] = args?.dashboardUid;
resourceInputs["orgId"] = args?.orgId;
resourceInputs["permission"] = args?.permission;
resourceInputs["role"] = args?.role;
resourceInputs["team"] = args?.team;
resourceInputs["user"] = args?.user;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "grafana:index/dashboardPermissionItem:DashboardPermissionItem" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
super(DashboardPermissionItem.__pulumiType, name, resourceInputs, opts);
}
}
exports.DashboardPermissionItem = DashboardPermissionItem;
/** @internal */
DashboardPermissionItem.__pulumiType = 'grafana:oss/dashboardPermissionItem:DashboardPermissionItem';
//# sourceMappingURL=dashboardPermissionItem.js.map