@pulumi/databricks
Version:
A Pulumi package for creating and managing databricks cloud resources.
104 lines • 4.33 kB
JavaScript
;
// *** 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.UserRole = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* This resource allows you to attach a role or databricks.InstanceProfile (AWS) to databricks_user.
*
* ## Example Usage
*
* Adding AWS instance profile to a user
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const instanceProfile = new databricks.InstanceProfile("instance_profile", {instanceProfileArn: "my_instance_profile_arn"});
* const myUser = new databricks.User("my_user", {userName: "me@example.com"});
* const myUserRole = new databricks.UserRole("my_user_role", {
* userId: myUser.id,
* role: instanceProfile.id,
* });
* ```
*
* Adding user as administrator to Databricks Account
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as databricks from "@pulumi/databricks";
*
* const myUser = new databricks.User("my_user", {userName: "me@example.com"});
* const myUserAccountAdmin = new databricks.UserRole("my_user_account_admin", {
* userId: myUser.id,
* role: "account_admin",
* });
* ```
*
* ## Related Resources
*
* The following resources are often used in the same context:
*
* * End to end workspace management guide.
* * databricks.GroupInstanceProfile to attach databricks.InstanceProfile (AWS) to databricks_group.
* * databricks.GroupMember to attach users and groups as group members.
* * databricks.InstanceProfile to manage AWS EC2 instance profiles that users can launch databricks.Cluster and access data, like databricks_mount.
* * databricks.User to [manage users](https://docs.databricks.com/administration-guide/users-groups/users.html), that could be added to databricks.Group within the workspace.
* * databricks.User data to retrieve information about databricks_user.
*
* ## Import
*
* !> Importing this resource is not currently supported.
*/
class UserRole extends pulumi.CustomResource {
/**
* Get an existing UserRole 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 UserRole(name, state, Object.assign(Object.assign({}, opts), { id: id }));
}
/**
* Returns true if the given object is an instance of UserRole. 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'] === UserRole.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["role"] = state ? state.role : undefined;
resourceInputs["userId"] = state ? state.userId : undefined;
}
else {
const args = argsOrState;
if ((!args || args.role === undefined) && !opts.urn) {
throw new Error("Missing required property 'role'");
}
if ((!args || args.userId === undefined) && !opts.urn) {
throw new Error("Missing required property 'userId'");
}
resourceInputs["role"] = args ? args.role : undefined;
resourceInputs["userId"] = args ? args.userId : undefined;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
super(UserRole.__pulumiType, name, resourceInputs, opts);
}
}
exports.UserRole = UserRole;
/** @internal */
UserRole.__pulumiType = 'databricks:index/userRole:UserRole';
//# sourceMappingURL=userRole.js.map