@pulumi/databricks/permissionAssignment.js

A Pulumi package for creating and managing databricks cloud resources.

"use strict";
// *** 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.PermissionAssignment = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * This resource is used to assign account-level users, service principals and groups to a Databricks workspace. To configure additional entitlements such as cluster creation, please use databricks.Entitlements
 *
 * > This resource can only be used with a workspace-level provider!
 *
 * ## Example Usage
 *
 * In workspace context, adding account-level user to a workspace:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * // Use the account provider
 * const me = databricks.getUser({
 *     userName: "me@example.com",
 * });
 * const addUser = new databricks.PermissionAssignment("add_user", {
 *     principalId: me.then(me => me.id),
 *     permissions: ["USER"],
 * });
 * ```
 *
 * In workspace context, adding account-level service principal to a workspace:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * // Use the account provider
 * const sp = databricks.getServicePrincipal({
 *     displayName: "Automation-only SP",
 * });
 * const addAdminSpn = new databricks.PermissionAssignment("add_admin_spn", {
 *     principalId: sp.then(sp => sp.id),
 *     permissions: ["ADMIN"],
 * });
 * ```
 *
 * In workspace context, adding account-level group to a workspace:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * // Use the account provider
 * const accountLevel = databricks.getGroup({
 *     displayName: "example-group",
 * });
 * // Use the workspace provider
 * const _this = new databricks.PermissionAssignment("this", {
 *     principalId: accountLevel.then(accountLevel => accountLevel.id),
 *     permissions: ["USER"],
 * });
 * const workspaceLevel = databricks.getGroup({
 *     displayName: "example-group",
 * });
 * export const databricksGroupId = workspaceLevel.then(workspaceLevel => workspaceLevel.id);
 * ```
 *
 * ## Related Resources
 *
 * The following resources are used in the same context:
 *
 * * databricks.Group to manage [Account-level](https://docs.databricks.com/aws/en/admin/users-groups/groups) or [Workspace-level](https://docs.databricks.com/aws/en/admin/users-groups/workspace-local-groups) groups.
 * * databricks.Group data to retrieve information about databricks.Group members, entitlements and instance profiles.
 * * databricks.GroupMember to attach users and groups as group members.
 * * databricks.MwsPermissionAssignment to manage permission assignment from an account context
 *
 * ## Import
 *
 * The resource `databricks_permission_assignment` can be imported using the principal id:
 *
 * hcl
 *
 * import {
 *
 *   to = databricks_permission_assignment.this
 *
 *   id = "<principal_id>"
 *
 * }
 *
 * Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/permissionAssignment:PermissionAssignment this "<principal_id>"
 * ```
 */
class PermissionAssignment extends pulumi.CustomResource {
    /**
     * Get an existing PermissionAssignment 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 PermissionAssignment(name, state, { ...opts, id: id });
    }
    /**
     * Returns true if the given object is an instance of PermissionAssignment.  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'] === PermissionAssignment.__pulumiType;
    }
    constructor(name, argsOrState, opts) {
        let resourceInputs = {};
        opts = opts || {};
        if (opts.id) {
            const state = argsOrState;
            resourceInputs["permissions"] = state?.permissions;
            resourceInputs["principalId"] = state?.principalId;
        }
        else {
            const args = argsOrState;
            if (args?.permissions === undefined && !opts.urn) {
                throw new Error("Missing required property 'permissions'");
            }
            if (args?.principalId === undefined && !opts.urn) {
                throw new Error("Missing required property 'principalId'");
            }
            resourceInputs["permissions"] = args?.permissions;
            resourceInputs["principalId"] = args?.principalId;
        }
        opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
        super(PermissionAssignment.__pulumiType, name, resourceInputs, opts);
    }
}
exports.PermissionAssignment = PermissionAssignment;
/** @internal */
PermissionAssignment.__pulumiType = 'databricks:index/permissionAssignment:PermissionAssignment';
//# sourceMappingURL=permissionAssignment.js.map