temporary_volume_credentials

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

Overview

Name	temporary_volume_credentials
Type	Resource
Id	databricks_workspace.catalog.temporary_volume_credentials

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
temporary_volume_credentials_generate_temporary_volume_credentials	insert	deployment_name		Get a short-lived credential for directly accessing the volume data on cloud storage. The metastore

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
deployment_name	string	The Databricks Workspace Deployment Name (default: dbc-abcd0123-a1bc)

INSERT examples

temporary_volume_credentials_generate_temporary_volume_credentials

Get a short-lived credential for directly accessing the volume data on cloud storage. The metastore

INSERT INTO databricks_workspace.catalog.temporary_volume_credentials (
operation,
volume_id,
deployment_name
)
SELECT 
'{{ operation }}',
'{{ volume_id }}',
'{{ deployment_name }}'
RETURNING
aws_temp_credentials,
azure_aad,
azure_user_delegation_sas,
expiration_time,
gcp_oauth_token,
r2_temp_credentials,
uc_encrypted_token,
url
;

Manifest

# Description fields are for documentation purposes
- name: temporary_volume_credentials
props:
  - name: deployment_name
    value: "{{ deployment_name }}"
    description: Required parameter for the temporary_volume_credentials resource.
  - name: operation
    value: "{{ operation }}"
    description: |
      The operation performed against the volume data, either READ_VOLUME or WRITE_VOLUME. If WRITE_VOLUME is specified, the credentials returned will have write permissions, otherwise, it will be read only.
  - name: volume_id
    value: "{{ volume_id }}"
    description: |
      Id of the volume to read or write.