credentials

Creates, updates, deletes, gets or lists a credentials resource.

Overview

Name	credentials
Type	Resource
Id	databricks_account.provisioning.credentials

Fields

The following fields are returned by SELECT queries:

get

The credential configuration was successfully returned.

Name	Datatype	Description
account_id	string
credentials_id	string
credentials_name	string
aws_credentials	object
creation_time	integer

list

Credential configurations were returned successfully.

Name	Datatype	Description
account_id	string
credentials_id	string
credentials_name	string
aws_credentials	object
creation_time	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a Databricks credential configuration object for an account, both specified by ID.
list	select			Gets all Databricks credential configurations associated with an account specified by ID.
create	insert			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.
delete	delete			Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot delete a credential that is associated with any workspace.

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

SELECT examples

get

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

SELECT
account_id,
credentials_id,
credentials_name,
aws_credentials,
creation_time
FROM databricks_account.provisioning.credentials;

list

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

SELECT
account_id,
credentials_id,
credentials_name,
aws_credentials,
creation_time
FROM databricks_account.provisioning.credentials;

INSERT examples

create

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.

INSERT INTO databricks_account.provisioning.credentials (
data__credentials_name,
data__aws_credentials
)
SELECT 
'{{ credentials_name }}',
'{{ aws_credentials }}'
;

Manifest

# Description fields are for documentation purposes
- name: credentials
  props:
    - name: credentials_name
      value: required
    - name: aws_credentials
      value: required

DELETE examples

delete

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

DELETE FROM databricks_account.provisioning.credentials;