com.databricks.sdk.service.compute

Class InstanceProfilesAPI

java.lang.Object

com.databricks.sdk.service.compute.InstanceProfilesAPI

@Generated
public class InstanceProfilesAPI
extends Object

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

Constructor Summary

Constructors

Constructor and Description
InstanceProfilesAPI(ApiClient apiClient) Regular-use constructor
InstanceProfilesAPI(InstanceProfilesService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
void	add(AddInstanceProfile request) Register an instance profile.
void	add(String instanceProfileArn)
void	edit(InstanceProfile request) Edit an instance profile.
void	edit(String instanceProfileArn)
InstanceProfilesService	impl()
Iterable<InstanceProfile>	list() List available instance profiles.
void	remove(RemoveInstanceProfile request) Remove the instance profile.
void	remove(String instanceProfileArn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InstanceProfilesAPI

public InstanceProfilesAPI(ApiClient apiClient)

Regular-use constructor

InstanceProfilesAPI

public InstanceProfilesAPI(InstanceProfilesService mock)

Constructor for mocks

Method Detail

add

public void add(String instanceProfileArn)

add

public void add(AddInstanceProfile request)

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

public void edit(String instanceProfileArn)

edit

public void edit(InstanceProfile request)

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

public Iterable<InstanceProfile> 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

public void remove(String instanceProfileArn)

remove

public void remove(RemoveInstanceProfile request)

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.

impl

public InstanceProfilesService impl()