storage_credentials

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

Overview

Name	storage_credentials
Type	Resource
Id	databricks_account.unity_catalog.storage_credentials

Fields

The following fields are returned by SELECT queries:

get

The storage credential was successfully retrieved.

Name	Datatype	Description
id	string
name	string
metastore_id	string
full_name	string
aws_iam_role	object
comment	string
created_at	integer
created_by	string
isolation_mode	string
owner	string
read_only	boolean
updated_at	integer
updated_by	string
used_for_managed_storage	boolean

list

The metastore storage credentials were successfully returned.

Name	Datatype	Description
id	string
name	string
metastore_id	string
full_name	string
aws_iam_role	object
comment	string
created_at	integer
created_by	string
isolation_mode	string
owner	string
read_only	boolean
updated_at	integer
updated_by	string
used_for_managed_storage	boolean

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select			Gets a storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have a level of privilege on the storage credential.
list	select			Gets a list of all storage credentials that have been assigned to given metastore.
create	insert			Creates a new storage credential. The request object is specific to the cloud:
update	replace			Updates a storage credential on the metastore. The caller must be the owner of the storage credential. If the caller is a metastore admin, only the
delete	delete			Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.

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 storage credential from the metastore. The caller must be a metastore admin, the owner of the storage credential, or have a level of privilege on the storage credential.

SELECT
id,
name,
metastore_id,
full_name,
aws_iam_role,
comment,
created_at,
created_by,
isolation_mode,
owner,
read_only,
updated_at,
updated_by,
used_for_managed_storage
FROM databricks_account.unity_catalog.storage_credentials;

list

Gets a list of all storage credentials that have been assigned to given metastore.

SELECT
id,
name,
metastore_id,
full_name,
aws_iam_role,
comment,
created_at,
created_by,
isolation_mode,
owner,
read_only,
updated_at,
updated_by,
used_for_managed_storage
FROM databricks_account.unity_catalog.storage_credentials;

INSERT examples

create

Creates a new storage credential. The request object is specific to the cloud:

INSERT INTO databricks_account.unity_catalog.storage_credentials (
data__credential_info
)
SELECT 
'{{ credential_info }}'
RETURNING
credential_info
;

Manifest

# Description fields are for documentation purposes
- name: storage_credentials
  props:
    - name: credential_info
      value: object

REPLACE examples

update

Updates a storage credential on the metastore. The caller must be the owner of the storage credential. If the caller is a metastore admin, only the

REPLACE databricks_account.unity_catalog.storage_credentials
SET 
data__credential_info = '{{ credential_info }}'
WHERE 
;

DELETE examples

delete

Deletes a storage credential from the metastore. The caller must be an owner of the storage credential.

DELETE FROM databricks_account.unity_catalog.storage_credentials;