Secrets

Package: databricks.bundles.secrets

Classes

class Lifecycle

prevent_destroy: bool | None = None

Lifecycle setting to prevent the resource from being destroyed.

classmethod from_dict(

value: dict,

) → Self

as_dict(

self,

) → dict

class Privilege

SELECT = 'SELECT'

READ_PRIVATE_FILES = 'READ_PRIVATE_FILES'

WRITE_PRIVATE_FILES = 'WRITE_PRIVATE_FILES'

CREATE = 'CREATE'

USAGE = 'USAGE'

USE_CATALOG = 'USE_CATALOG'

USE_SCHEMA = 'USE_SCHEMA'

CREATE_SCHEMA = 'CREATE_SCHEMA'

CREATE_VIEW = 'CREATE_VIEW'

CREATE_EXTERNAL_TABLE = 'CREATE_EXTERNAL_TABLE'

CREATE_MATERIALIZED_VIEW = 'CREATE_MATERIALIZED_VIEW'

CREATE_FUNCTION = 'CREATE_FUNCTION'

CREATE_MODEL = 'CREATE_MODEL'

CREATE_CATALOG = 'CREATE_CATALOG'

CREATE_MANAGED_STORAGE = 'CREATE_MANAGED_STORAGE'

CREATE_EXTERNAL_LOCATION = 'CREATE_EXTERNAL_LOCATION'

CREATE_STORAGE_CREDENTIAL = 'CREATE_STORAGE_CREDENTIAL'

CREATE_SERVICE_CREDENTIAL = 'CREATE_SERVICE_CREDENTIAL'

ACCESS = 'ACCESS'

CREATE_SHARE = 'CREATE_SHARE'

CREATE_RECIPIENT = 'CREATE_RECIPIENT'

CREATE_PROVIDER = 'CREATE_PROVIDER'

USE_SHARE = 'USE_SHARE'

USE_RECIPIENT = 'USE_RECIPIENT'

USE_PROVIDER = 'USE_PROVIDER'

USE_MARKETPLACE_ASSETS = 'USE_MARKETPLACE_ASSETS'

SET_SHARE_PERMISSION = 'SET_SHARE_PERMISSION'

MODIFY = 'MODIFY'

REFRESH = 'REFRESH'

EXECUTE = 'EXECUTE'

READ_FILES = 'READ_FILES'

WRITE_FILES = 'WRITE_FILES'

CREATE_TABLE = 'CREATE_TABLE'

ALL_PRIVILEGES = 'ALL_PRIVILEGES'

CREATE_CONNECTION = 'CREATE_CONNECTION'

USE_CONNECTION = 'USE_CONNECTION'

APPLY_TAG = 'APPLY_TAG'

CREATE_FOREIGN_CATALOG = 'CREATE_FOREIGN_CATALOG'

CREATE_FOREIGN_SECURABLE = 'CREATE_FOREIGN_SECURABLE'

MANAGE_ALLOWLIST = 'MANAGE_ALLOWLIST'

CREATE_VOLUME = 'CREATE_VOLUME'

CREATE_EXTERNAL_VOLUME = 'CREATE_EXTERNAL_VOLUME'

READ_VOLUME = 'READ_VOLUME'

WRITE_VOLUME = 'WRITE_VOLUME'

MANAGE = 'MANAGE'

BROWSE = 'BROWSE'

CREATE_CLEAN_ROOM = 'CREATE_CLEAN_ROOM'

MODIFY_CLEAN_ROOM = 'MODIFY_CLEAN_ROOM'

EXECUTE_CLEAN_ROOM_TASK = 'EXECUTE_CLEAN_ROOM_TASK'

EXTERNAL_USE_SCHEMA = 'EXTERNAL_USE_SCHEMA'

READ_METADATA = 'READ_METADATA'

EXTERNAL_USE_LOCATION = 'EXTERNAL_USE_LOCATION'

class PrivilegeAssignment

principal: str | None = None

The principal (user email address or group name). For deleted principals, principal is empty while principal_id is populated.

privileges: list[Privilege]

The privileges assigned to the principal.

classmethod from_dict(

value: dict,

) → Self

as_dict(

self,

) → dict

class Secret

A secret stored in Unity Catalog. Secrets are three-level namespace objects (catalog.schema.secret) that securely store sensitive credential data such as passwords, tokens, and keys.

catalog_name: str

The name of the catalog where the schema and the secret reside.

name: str

The name of the secret, relative to its parent schema.

schema_name: str

The name of the schema where the secret resides.

value: str

The secret value to store. Must be a variable reference (e.g. ${var.my_secret}) to prevent plain-text secrets in configuration files.

comment: str | None = None

User-provided free-form text description of the secret.

expire_time: str | None = None

User-provided expiration time of the secret. Purely informational; does not trigger automatic actions.

grants: list[PrivilegeAssignment]

The grants to apply on this secret.

lifecycle: Lifecycle | None = None

Settings that control the deployment lifecycle of the resource, such as preventing it from being destroyed.

owner: str | None = None

The owner of the secret. Defaults to the creating principal on creation. Can be updated to transfer ownership of the secret to another principal.

classmethod from_dict(

value: dict,

) → Self

as_dict(

self,

) → dict