@pulumiverse/grafana/oss/folderPermissionItem.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages a single permission item for a folder. Conflicts with the "grafana.oss.FolderPermission" resource which manages the entire set of permissions for a folder.
 * 		* [Official documentation](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/access-control/)
 * 		* [HTTP API](https://grafana.com/docs/grafana/latest/developer-resources/api-reference/http-api/api-legacy/folder_permissions/)
 *
 * ## 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",
 *     login: "user.name",
 *     password: "my-password",
 * });
 * const collection = new grafana.oss.Folder("collection", {title: "Folder Title"});
 * const onRole = new grafana.oss.FolderPermissionItem("on_role", {
 *     folderUid: collection.uid,
 *     role: "Viewer",
 *     permission: "Edit",
 * });
 * const onTeam = new grafana.oss.FolderPermissionItem("on_team", {
 *     folderUid: collection.uid,
 *     team: team.id,
 *     permission: "View",
 * });
 * const onUser = new grafana.oss.FolderPermissionItem("on_user", {
 *     folderUid: collection.uid,
 *     user: user.id,
 *     permission: "Admin",
 * });
 * ```
 *
 * ## Import
 *
 * ```sh
 * terraform import grafana_folder_permission_item.name "{{ folderUID }}:{{ type (role, team, or user) }}:{{ identifier }}"
 * terraform import grafana_folder_permission_item.name "{{ orgID }}:{{ folderUID }}:{{ type (role, team, or user) }}:{{ identifier }}"
 * ```
 */
export declare class FolderPermissionItem extends pulumi.CustomResource {
    /**
     * Get an existing FolderPermissionItem 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?: FolderPermissionItemState, opts?: pulumi.CustomResourceOptions): FolderPermissionItem;
    /**
     * Returns true if the given object is an instance of FolderPermissionItem.  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 FolderPermissionItem;
    /**
     * The UID of the folder.
     */
    readonly folderUid: pulumi.Output<string>;
    /**
     * The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
     */
    readonly orgId: pulumi.Output<string>;
    /**
     * the permission to be assigned
     */
    readonly permission: pulumi.Output<string>;
    /**
     * the role onto which the permission is to be assigned
     */
    readonly role: pulumi.Output<string | undefined>;
    /**
     * the team onto which the permission is to be assigned
     */
    readonly team: pulumi.Output<string | undefined>;
    /**
     * the user or service account onto which the permission is to be assigned
     */
    readonly user: pulumi.Output<string | undefined>;
    /**
     * Create a FolderPermissionItem 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.
     */
    constructor(name: string, args: FolderPermissionItemArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FolderPermissionItem resources.
 */
export interface FolderPermissionItemState {
    /**
     * The UID of the folder.
     */
    folderUid?: pulumi.Input<string>;
    /**
     * The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
     */
    orgId?: pulumi.Input<string>;
    /**
     * the permission to be assigned
     */
    permission?: pulumi.Input<string>;
    /**
     * the role onto which the permission is to be assigned
     */
    role?: pulumi.Input<string>;
    /**
     * the team onto which the permission is to be assigned
     */
    team?: pulumi.Input<string>;
    /**
     * the user or service account onto which the permission is to be assigned
     */
    user?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FolderPermissionItem resource.
 */
export interface FolderPermissionItemArgs {
    /**
     * The UID of the folder.
     */
    folderUid: pulumi.Input<string>;
    /**
     * The Organization ID. If not set, the default organization is used for basic authentication, or the one that owns your service account for token authentication.
     */
    orgId?: pulumi.Input<string>;
    /**
     * the permission to be assigned
     */
    permission: pulumi.Input<string>;
    /**
     * the role onto which the permission is to be assigned
     */
    role?: pulumi.Input<string>;
    /**
     * the team onto which the permission is to be assigned
     */
    team?: pulumi.Input<string>;
    /**
     * the user or service account onto which the permission is to be assigned
     */
    user?: pulumi.Input<string>;
}