@pulumi/databricks/userRole.d.ts

A Pulumi package for creating and managing databricks cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * 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.
 */
export declare 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: string, id: pulumi.Input<pulumi.ID>, state?: UserRoleState, opts?: pulumi.CustomResourceOptions): UserRole;
    /**
     * 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: any): obj is UserRole;
    /**
     * Either a role name or the ARN/ID of the instance profile resource.
     */
    readonly role: pulumi.Output<string>;
    /**
     * This is the id of the user resource.
     */
    readonly userId: pulumi.Output<string>;
    /**
     * Create a UserRole 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: UserRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering UserRole resources.
 */
export interface UserRoleState {
    /**
     * Either a role name or the ARN/ID of the instance profile resource.
     */
    role?: pulumi.Input<string>;
    /**
     * This is the id of the user resource.
     */
    userId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a UserRole resource.
 */
export interface UserRoleArgs {
    /**
     * Either a role name or the ARN/ID of the instance profile resource.
     */
    role: pulumi.Input<string>;
    /**
     * This is the id of the user resource.
     */
    userId: pulumi.Input<string>;
}