@pulumi/databricks/mwsPermissionAssignment.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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 an account-level provider!
 *
 * ## Example Usage
 *
 * In account context, adding account-level group to a workspace:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const dataEng = new databricks.Group("data_eng", {displayName: "Data Engineering"});
 * const addAdminGroup = new databricks.MwsPermissionAssignment("add_admin_group", {
 *     workspaceId: _this.workspaceId,
 *     principalId: dataEng.id,
 *     permissions: ["ADMIN"],
 * });
 * ```
 *
 * In account context, adding account-level user to a workspace:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const me = new databricks.User("me", {userName: "me@example.com"});
 * const addUser = new databricks.MwsPermissionAssignment("add_user", {
 *     workspaceId: _this.workspaceId,
 *     principalId: me.id,
 *     permissions: ["USER"],
 * });
 * ```
 *
 * In account context, adding account-level service principal to a workspace:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as databricks from "@pulumi/databricks";
 *
 * const sp = new databricks.ServicePrincipal("sp", {displayName: "Automation-only SP"});
 * const addAdminSpn = new databricks.MwsPermissionAssignment("add_admin_spn", {
 *     workspaceId: _this.workspaceId,
 *     principalId: sp.id,
 *     permissions: ["ADMIN"],
 * });
 * ```
 *
 * ## 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.PermissionAssignment to manage permission assignment from a workspace context
 *
 * ## Import
 *
 * The resource `databricks_mws_permission_assignment` can be imported using the workspace id and principal id
 *
 * hcl
 *
 * import {
 *
 *   to = databricks_mws_permission_assignment.this
 *
 *   id = "workspace_id|principal_id"
 *
 * }
 *
 * Alternatively, when using `terraform` version 1.4 or earlier, import using the `pulumi import` command:
 *
 * bash
 *
 * ```sh
 * $ pulumi import databricks:index/mwsPermissionAssignment:MwsPermissionAssignment this "workspace_id|principal_id"
 * ```
 */
export declare class MwsPermissionAssignment extends pulumi.CustomResource {
    /**
     * Get an existing MwsPermissionAssignment 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?: MwsPermissionAssignmentState, opts?: pulumi.CustomResourceOptions): MwsPermissionAssignment;
    /**
     * Returns true if the given object is an instance of MwsPermissionAssignment.  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 MwsPermissionAssignment;
    /**
     * The list of workspace permissions to assign to the principal:
     * * `"USER"` - Adds principal to the workspace `users` group. This gives basic workspace access.
     * * `"ADMIN"` - Adds principal to the workspace `admins` group. This gives workspace admin privileges to manage users and groups, workspace configurations, and more.
     */
    readonly permissions: pulumi.Output<string[]>;
    /**
     * Databricks ID of the user, service principal, or group. The principal ID can be retrieved using the SCIM API, or using databricks_user, databricks.ServicePrincipal or databricks.Group data sources.
     */
    readonly principalId: pulumi.Output<string>;
    /**
     * Databricks workspace ID.
     */
    readonly workspaceId: pulumi.Output<string>;
    /**
     * Create a MwsPermissionAssignment 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: MwsPermissionAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering MwsPermissionAssignment resources.
 */
export interface MwsPermissionAssignmentState {
    /**
     * The list of workspace permissions to assign to the principal:
     * * `"USER"` - Adds principal to the workspace `users` group. This gives basic workspace access.
     * * `"ADMIN"` - Adds principal to the workspace `admins` group. This gives workspace admin privileges to manage users and groups, workspace configurations, and more.
     */
    permissions?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Databricks ID of the user, service principal, or group. The principal ID can be retrieved using the SCIM API, or using databricks_user, databricks.ServicePrincipal or databricks.Group data sources.
     */
    principalId?: pulumi.Input<string>;
    /**
     * Databricks workspace ID.
     */
    workspaceId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a MwsPermissionAssignment resource.
 */
export interface MwsPermissionAssignmentArgs {
    /**
     * The list of workspace permissions to assign to the principal:
     * * `"USER"` - Adds principal to the workspace `users` group. This gives basic workspace access.
     * * `"ADMIN"` - Adds principal to the workspace `admins` group. This gives workspace admin privileges to manage users and groups, workspace configurations, and more.
     */
    permissions: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * Databricks ID of the user, service principal, or group. The principal ID can be retrieved using the SCIM API, or using databricks_user, databricks.ServicePrincipal or databricks.Group data sources.
     */
    principalId: pulumi.Input<string>;
    /**
     * Databricks workspace ID.
     */
    workspaceId: pulumi.Input<string>;
}