instance_profiles

Creates, updates, deletes, gets or lists an instance_profiles resource.

Overview

Name	instance_profiles
Type	Resource
Id	databricks_workspace.compute.instance_profiles

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
instance_profile_arn	string
is_meta_instance_profile	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	deployment_name		List the instance profiles that the calling user can use to launch a cluster.
add	insert	deployment_name		In the UI, you can select the instance profile when launching clusters. This API is only available to admin users.
edit	replace	deployment_name		The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true:
remove	delete	deployment_name		Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

SELECT examples

list

List the instance profiles that the calling user can use to launch a cluster.

SELECT
instance_profile_arn,
is_meta_instance_profile
FROM databricks_workspace.compute.instance_profiles
WHERE deployment_name = '{{ deployment_name }}' -- required;

INSERT examples

add

In the UI, you can select the instance profile when launching clusters. This API is only available to admin users.

INSERT INTO databricks_workspace.compute.instance_profiles (
data__skip_validation,
data__instance_profile_arn,
data__iam_role_arn,
data__is_meta_instance_profile,
deployment_name
)
SELECT 
{{ skip_validation }},
'{{ instance_profile_arn }}',
'{{ iam_role_arn }}',
'{{ is_meta_instance_profile }}',
'{{ deployment_name }}'
;

Manifest

# Description fields are for documentation purposes
- name: instance_profiles
  props:
    - name: deployment_name
      value: string
      description: Required parameter for the instance_profiles resource.
    - name: skip_validation
      value: boolean
    - name: instance_profile_arn
      value: required
    - name: iam_role_arn
      value: string
    - name: is_meta_instance_profile
      value: string

REPLACE examples

edit

The only supported field to change is the optional IAM role ARN associated with the instance profile. It is required to specify the IAM role ARN if both of the following are true:

REPLACE databricks_workspace.compute.instance_profiles
SET 
data__instance_profile_arn = '{{ instance_profile_arn }}',
data__iam_role_arn = '{{ iam_role_arn }}',
data__is_meta_instance_profile = '{{ is_meta_instance_profile }}'
WHERE 
deployment_name = '{{ deployment_name }}' --required;

DELETE examples

remove

Remove the instance profile with the provided ARN. Existing clusters with this instance profile will continue to function.

DELETE FROM databricks_workspace.compute.instance_profiles
WHERE deployment_name = '{{ deployment_name }}' --required;