UNPKG

@pulumiverse/grafana

Version:

A Pulumi package for creating and managing grafana.

118 lines 5.88 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.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 * $ pulumi import grafana:index/dashboardPermissionItem:DashboardPermissionItem name "{{ dashboardUID }}:{{ type (role, team, or user) }}:{{ identifier }}" * ``` * * ```sh * $ pulumi import grafana:index/dashboardPermissionItem:DashboardPermissionItem name "{{ orgID }}:{{ dashboardUID }}:{{ type (role, team, or user) }}:{{ identifier }}" * ``` * * @deprecated grafana.index/dashboardpermissionitem.DashboardPermissionItem has been deprecated in favor of grafana.oss/dashboardpermissionitem.DashboardPermissionItem */ 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) { pulumi.log.warn("DashboardPermissionItem is deprecated: grafana.index/dashboardpermissionitem.DashboardPermissionItem has been deprecated in favor of grafana.oss/dashboardpermissionitem.DashboardPermissionItem"); return new DashboardPermissionItem(name, state, Object.assign(Object.assign({}, 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; } /** @deprecated grafana.index/dashboardpermissionitem.DashboardPermissionItem has been deprecated in favor of grafana.oss/dashboardpermissionitem.DashboardPermissionItem */ constructor(name, argsOrState, opts) { pulumi.log.warn("DashboardPermissionItem is deprecated: grafana.index/dashboardpermissionitem.DashboardPermissionItem has been deprecated in favor of grafana.oss/dashboardpermissionitem.DashboardPermissionItem"); let resourceInputs = {}; opts = opts || {}; if (opts.id) { const state = argsOrState; resourceInputs["dashboardUid"] = state ? state.dashboardUid : undefined; resourceInputs["orgId"] = state ? state.orgId : undefined; resourceInputs["permission"] = state ? state.permission : undefined; resourceInputs["role"] = state ? state.role : undefined; resourceInputs["team"] = state ? state.team : undefined; resourceInputs["user"] = state ? state.user : undefined; } else { const args = argsOrState; if ((!args || args.dashboardUid === undefined) && !opts.urn) { throw new Error("Missing required property 'dashboardUid'"); } if ((!args || args.permission === undefined) && !opts.urn) { throw new Error("Missing required property 'permission'"); } resourceInputs["dashboardUid"] = args ? args.dashboardUid : undefined; resourceInputs["orgId"] = args ? args.orgId : undefined; resourceInputs["permission"] = args ? args.permission : undefined; resourceInputs["role"] = args ? args.role : undefined; resourceInputs["team"] = args ? args.team : undefined; resourceInputs["user"] = args ? args.user : undefined; } 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:index/dashboardPermissionItem:DashboardPermissionItem'; //# sourceMappingURL=dashboardPermissionItem.js.map