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:

credentials_get

Name	Datatype	Description
account_id	string
credentials_id	string	Databricks credential configuration ID.
credentials_name	string	The human-readable name of the credential configuration object.
▶aws_credentials	object
creation_time	integer	Time in epoch milliseconds when the credential was created.

credentials_list

Name	Datatype	Description
account_id	string
credentials_id	string	Databricks credential configuration ID.
credentials_name	string	The human-readable name of the credential configuration object.
▶aws_credentials	object
creation_time	integer	Time in epoch milliseconds when the credential was created.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
credentials_get	select	account_id, credentials_id		Gets a Databricks credential configuration object for an account, both specified by ID.
credentials_list	select	account_id		List Databricks credential configuration objects for an account, specified by ID.
credentials_create	insert	account_id, credentials_name, aws_credentials		Creates a Databricks credential configuration that represents cloud cross-account credentials for a
credentials_delete	delete	account_id, credentials_id		Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot

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
account_id	string
credentials_id	string	Databricks Account API credential configuration ID

SELECT examples

credentials_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
WHERE account_id = '{{ account_id }}' -- required
AND credentials_id = '{{ credentials_id }}' -- required
;

credentials_list

List Databricks credential configuration objects for an account, specified by ID.

SELECT
account_id,
credentials_id,
credentials_name,
aws_credentials,
creation_time
FROM databricks_account.provisioning.credentials
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

credentials_create

Creates a Databricks credential configuration that represents cloud cross-account credentials for a

INSERT INTO databricks_account.provisioning.credentials (
credentials_name,
aws_credentials,
account_id
)
SELECT 
'{{ credentials_name }}' /* required */,
'{{ aws_credentials }}' /* required */,
'{{ account_id }}'
RETURNING
account_id,
credentials_id,
credentials_name,
aws_credentials,
creation_time
;

Manifest

# Description fields are for documentation purposes
- name: credentials
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the credentials resource.
  - name: credentials_name
    value: "{{ credentials_name }}"
    description: |
      The human-readable name of the credential configuration object.
  - name: aws_credentials
    value:
      sts_role:
        role_arn: "{{ role_arn }}"

DELETE examples

credentials_delete

Deletes a Databricks credential configuration object for an account, both specified by ID. You cannot

DELETE FROM databricks_account.provisioning.credentials
WHERE account_id = '{{ account_id }}' --required
AND credentials_id = '{{ credentials_id }}' --required
;