com.databricks.sdk.service.compute

Interface InstanceProfilesService

@Generated
public interface InstanceProfilesService

The Instance Profiles API allows admins to add, list, and remove instance profiles that users can launch clusters with. Regular users can list the instance profiles available to them. See [Secure access to S3 buckets] using instance profiles for more information.

[Secure access to S3 buckets]: https://docs.databricks.com/administration-guide/cloud-configurations/aws/instance-profiles.html

This is the high-level interface, that contains generated methods.

Evolving: this interface is under development. Method signatures may change.

Method Summary

Modifier and Type	Method and Description
void	add(AddInstanceProfile addInstanceProfile) Register an instance profile.
void	edit(InstanceProfile instanceProfile) Edit an instance profile.
ListInstanceProfilesResponse	list() List available instance profiles.
void	remove(RemoveInstanceProfile removeInstanceProfile) Remove the instance profile.

Method Detail

add

void add(AddInstanceProfile addInstanceProfile)

Register an instance profile.

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

edit

void edit(InstanceProfile instanceProfile)

Edit an instance profile.

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:

* Your role name and instance profile name do not match. The name is the part after the last slash in each ARN. * You want to use the instance profile with [Databricks SQL Serverless].

To understand where these fields are in the AWS console, see [Enable serverless SQL warehouses].

This API is only available to admin users.

[Databricks SQL Serverless]: https://docs.databricks.com/sql/admin/serverless.html [Enable serverless SQL warehouses]: https://docs.databricks.com/sql/admin/serverless.html

list

ListInstanceProfilesResponse list()

List available instance profiles.

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

This API is available to all users.

remove

void remove(RemoveInstanceProfile removeInstanceProfile)

Remove the instance profile.

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

This API is only accessible to admin users.