@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
142 lines • 5.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.MwsPermissionAssignment = 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 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"
* ```
*/
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, id, state, opts) {
return new MwsPermissionAssignment(name, state, { ...opts, id: id });
}
/**
* 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) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === MwsPermissionAssignment.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["permissions"] = state?.permissions;
resourceInputs["principalId"] = state?.principalId;
resourceInputs["workspaceId"] = state?.workspaceId;
}
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'");
}
if (args?.workspaceId === undefined && !opts.urn) {
throw new Error("Missing required property 'workspaceId'");
}
resourceInputs["permissions"] = args?.permissions;
resourceInputs["principalId"] = args?.principalId;
resourceInputs["workspaceId"] = args?.workspaceId;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(MwsPermissionAssignment.__pulumiType, name, resourceInputs, opts);
}
}
exports.MwsPermissionAssignment = MwsPermissionAssignment;
/** @internal */
MwsPermissionAssignment.__pulumiType = 'databricks:index/mwsPermissionAssignment:MwsPermissionAssignment';
//# sourceMappingURL=mwsPermissionAssignment.js.map