Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. UserInstanceProfile
Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.UserInstanceProfile

Explore with Pulumi AI

Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks

Deprecated Please rewrite with databricks_user_role. This resource will be removed in v0.5.x

This resource allows you to attach databricks.InstanceProfile (AWS) to databricks_user.

Example Usage

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 myUserInstanceProfile = new databricks.UserInstanceProfile("my_user_instance_profile", {
    userId: myUser.id,
    instanceProfileId: instanceProfile.id,
});
Copy
import pulumi
import pulumi_databricks as databricks

instance_profile = databricks.InstanceProfile("instance_profile", instance_profile_arn="my_instance_profile_arn")
my_user = databricks.User("my_user", user_name="me@example.com")
my_user_instance_profile = databricks.UserInstanceProfile("my_user_instance_profile",
    user_id=my_user.id,
    instance_profile_id=instance_profile.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		instanceProfile, err := databricks.NewInstanceProfile(ctx, "instance_profile", &databricks.InstanceProfileArgs{
			InstanceProfileArn: pulumi.String("my_instance_profile_arn"),
		})
		if err != nil {
			return err
		}
		myUser, err := databricks.NewUser(ctx, "my_user", &databricks.UserArgs{
			UserName: pulumi.String("me@example.com"),
		})
		if err != nil {
			return err
		}
		_, err = databricks.NewUserInstanceProfile(ctx, "my_user_instance_profile", &databricks.UserInstanceProfileArgs{
			UserId:            myUser.ID(),
			InstanceProfileId: instanceProfile.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var instanceProfile = new Databricks.InstanceProfile("instance_profile", new()
    {
        InstanceProfileArn = "my_instance_profile_arn",
    });

    var myUser = new Databricks.User("my_user", new()
    {
        UserName = "me@example.com",
    });

    var myUserInstanceProfile = new Databricks.UserInstanceProfile("my_user_instance_profile", new()
    {
        UserId = myUser.Id,
        InstanceProfileId = instanceProfile.Id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.InstanceProfile;
import com.pulumi.databricks.InstanceProfileArgs;
import com.pulumi.databricks.User;
import com.pulumi.databricks.UserArgs;
import com.pulumi.databricks.UserInstanceProfile;
import com.pulumi.databricks.UserInstanceProfileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var instanceProfile = new InstanceProfile("instanceProfile", InstanceProfileArgs.builder()
            .instanceProfileArn("my_instance_profile_arn")
            .build());

        var myUser = new User("myUser", UserArgs.builder()
            .userName("me@example.com")
            .build());

        var myUserInstanceProfile = new UserInstanceProfile("myUserInstanceProfile", UserInstanceProfileArgs.builder()
            .userId(myUser.id())
            .instanceProfileId(instanceProfile.id())
            .build());

    }
}
Copy
resources:
  instanceProfile:
    type: databricks:InstanceProfile
    name: instance_profile
    properties:
      instanceProfileArn: my_instance_profile_arn
  myUser:
    type: databricks:User
    name: my_user
    properties:
      userName: me@example.com
  myUserInstanceProfile:
    type: databricks:UserInstanceProfile
    name: my_user_instance_profile
    properties:
      userId: ${myUser.id}
      instanceProfileId: ${instanceProfile.id}
Copy

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, that could be added to databricks.Group within the workspace.
  • databricks.User data to retrieve information about databricks_user.

Create UserInstanceProfile Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new UserInstanceProfile(name: string, args: UserInstanceProfileArgs, opts?: CustomResourceOptions);
@overload
def UserInstanceProfile(resource_name: str,
                        args: UserInstanceProfileArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def UserInstanceProfile(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        instance_profile_id: Optional[str] = None,
                        user_id: Optional[str] = None)
func NewUserInstanceProfile(ctx *Context, name string, args UserInstanceProfileArgs, opts ...ResourceOption) (*UserInstanceProfile, error)
public UserInstanceProfile(string name, UserInstanceProfileArgs args, CustomResourceOptions? opts = null)
public UserInstanceProfile(String name, UserInstanceProfileArgs args)
public UserInstanceProfile(String name, UserInstanceProfileArgs args, CustomResourceOptions options)

type: databricks:UserInstanceProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserInstanceProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserInstanceProfileArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserInstanceProfileArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserInstanceProfileArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserInstanceProfileArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var userInstanceProfileResource = new Databricks.UserInstanceProfile("userInstanceProfileResource", new()
{
    InstanceProfileId = "string",
    UserId = "string",
});
Copy
example, err := databricks.NewUserInstanceProfile(ctx, "userInstanceProfileResource", &databricks.UserInstanceProfileArgs{
	InstanceProfileId: pulumi.String("string"),
	UserId:            pulumi.String("string"),
})
Copy
var userInstanceProfileResource = new UserInstanceProfile("userInstanceProfileResource", UserInstanceProfileArgs.builder()
    .instanceProfileId("string")
    .userId("string")
    .build());
Copy
user_instance_profile_resource = databricks.UserInstanceProfile("userInstanceProfileResource",
    instance_profile_id="string",
    user_id="string")
Copy
const userInstanceProfileResource = new databricks.UserInstanceProfile("userInstanceProfileResource", {
    instanceProfileId: "string",
    userId: "string",
});
Copy
type: databricks:UserInstanceProfile
properties:
    instanceProfileId: string
    userId: string
Copy

UserInstanceProfile Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The UserInstanceProfile resource accepts the following input properties:

InstanceProfileId
This property is required.
Changes to this property will trigger replacement.
string
This is the id of the instance profile resource.
UserId
This property is required.
Changes to this property will trigger replacement.
string
This is the id of the user resource.
InstanceProfileId
This property is required.
Changes to this property will trigger replacement.
string
This is the id of the instance profile resource.
UserId
This property is required.
Changes to this property will trigger replacement.
string
This is the id of the user resource.
instanceProfileId
This property is required.
Changes to this property will trigger replacement.
String
This is the id of the instance profile resource.
userId
This property is required.
Changes to this property will trigger replacement.
String
This is the id of the user resource.
instanceProfileId
This property is required.
Changes to this property will trigger replacement.
string
This is the id of the instance profile resource.
userId
This property is required.
Changes to this property will trigger replacement.
string
This is the id of the user resource.
instance_profile_id
This property is required.
Changes to this property will trigger replacement.
str
This is the id of the instance profile resource.
user_id
This property is required.
Changes to this property will trigger replacement.
str
This is the id of the user resource.
instanceProfileId
This property is required.
Changes to this property will trigger replacement.
String
This is the id of the instance profile resource.
userId
This property is required.
Changes to this property will trigger replacement.
String
This is the id of the user resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the UserInstanceProfile resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing UserInstanceProfile Resource

Get an existing UserInstanceProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: UserInstanceProfileState, opts?: CustomResourceOptions): UserInstanceProfile
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        instance_profile_id: Optional[str] = None,
        user_id: Optional[str] = None) -> UserInstanceProfile
func GetUserInstanceProfile(ctx *Context, name string, id IDInput, state *UserInstanceProfileState, opts ...ResourceOption) (*UserInstanceProfile, error)
public static UserInstanceProfile Get(string name, Input<string> id, UserInstanceProfileState? state, CustomResourceOptions? opts = null)
public static UserInstanceProfile get(String name, Output<String> id, UserInstanceProfileState state, CustomResourceOptions options)
resources:  _:    type: databricks:UserInstanceProfile    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
InstanceProfileId Changes to this property will trigger replacement. string
This is the id of the instance profile resource.
UserId Changes to this property will trigger replacement. string
This is the id of the user resource.
InstanceProfileId Changes to this property will trigger replacement. string
This is the id of the instance profile resource.
UserId Changes to this property will trigger replacement. string
This is the id of the user resource.
instanceProfileId Changes to this property will trigger replacement. String
This is the id of the instance profile resource.
userId Changes to this property will trigger replacement. String
This is the id of the user resource.
instanceProfileId Changes to this property will trigger replacement. string
This is the id of the instance profile resource.
userId Changes to this property will trigger replacement. string
This is the id of the user resource.
instance_profile_id Changes to this property will trigger replacement. str
This is the id of the instance profile resource.
user_id Changes to this property will trigger replacement. str
This is the id of the user resource.
instanceProfileId Changes to this property will trigger replacement. String
This is the id of the instance profile resource.
userId Changes to this property will trigger replacement. String
This is the id of the user resource.

Import

!> Importing this resource is not currently supported.

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes
This Pulumi package is based on the databricks Terraform Provider.
Databricks v1.67.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-databricks