Package com.databricks.sdk.service.provisioning

Class CredentialsAPI

java.lang.Object

com.databricks.sdk.service.provisioning.CredentialsAPI

@Generated
public class CredentialsAPI
extends Object

These APIs manage credential configurations for this workspace. Databricks needs access to a cross-account service IAM role in your AWS account so that Databricks can deploy clusters in the appropriate VPC for the new workspace. A credential configuration encapsulates this role information, and its ID is used when creating a new workspace.

Constructor Summary

Constructors

Constructor	Description
CredentialsAPI(ApiClient apiClient)	Regular-use constructor
CredentialsAPI(CredentialsService mock)	Constructor for mocks

Method Summary

Modifier and Type	Method	Description
Credential	create(CreateCredentialRequest request)	Create credential configuration.
Credential	create(String credentialsName, CreateCredentialAwsCredentials awsCredentials)
void	delete(DeleteCredentialRequest request)	Delete credential configuration.
void	delete(String credentialsId)
Credential	get(GetCredentialRequest request)	Get credential configuration.
Credential	get(String credentialsId)
CredentialsService	impl()
Iterable<Credential>	list()	Get all credential configurations.

Methods inherited from class java.lang.Object

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

Constructor Detail

CredentialsAPI

public CredentialsAPI(ApiClient apiClient)

Regular-use constructor

CredentialsAPI

public CredentialsAPI(CredentialsService mock)

Constructor for mocks

Method Detail

create

public Credential create(String credentialsName,
                         CreateCredentialAwsCredentials awsCredentials)

create

public Credential create(CreateCredentialRequest request)

Create credential configuration.

Creates a Databricks credential configuration that represents cloud cross-account credentials for a specified account. Databricks uses this to set up network infrastructure properly to host Databricks clusters. For your AWS IAM role, you need to trust the External ID (the Databricks Account API account ID) in the returned credential object, and configure the required access policy.

Save the response's `credentials_id` field, which is the ID for your new credential configuration object.

For information about how to create a new workspace with this API, see [Create a new workspace using the Account API]

[Create a new workspace using the Account API]: http://docs.databricks.com/administration-guide/account-api/new-workspace.html

delete

public void delete(String credentialsId)

delete

public void delete(DeleteCredentialRequest request)

Delete credential configuration.

Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace.

get

public Credential get(String credentialsId)

get

public Credential get(GetCredentialRequest request)

Get credential configuration.

Gets a Databricks credential configuration object for an account, both specified by ID.

list

public Iterable<Credential> list()

Get all credential configurations.

Gets all Databricks credential configurations associated with an account specified by ID.

impl

public CredentialsService impl()