Database Instances

Package: databricks.bundles.database_instances

Classes

class CustomTag
classmethod from_dict(
value: dict,
) → Self
as_dict(
self,
) → dict
class DatabaseInstance

A DatabaseInstance represents a logical Postgres instance, comprised of both compute and storage.

name: str

[Public Preview] The name of the instance. This is the unique identifier for the instance.

capacity: str | None = None

[Public Preview] The sku of the instance. Valid values are “CU_1”, “CU_2”, “CU_4”, “CU_8”.

enable_pg_native_login: bool | None = None

[Public Preview] Whether to enable PG native password login on the instance. Defaults to false.

enable_readable_secondaries: bool | None = None

[Public Preview] Whether to enable secondaries to serve read-only traffic. Defaults to false.

lifecycle: Lifecycle | None = None

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

node_count: int | None = None

[Public Preview] The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries. This field is input only, see effective_node_count for the output.

parent_instance_ref: DatabaseInstanceRef | None = None

[Public Preview] The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance.

permissions: list[Permission]

The permissions to apply to this resource.

retention_window_in_days: int | None = None

[Public Preview] The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days.

stopped: bool | None = None

[Public Preview] Whether to stop the instance. An input only param, see effective_stopped for the output.

classmethod from_dict(
value: dict,
) → Self
as_dict(
self,
) → dict
class DatabaseInstanceRef

DatabaseInstanceRef is a reference to a database instance. It is used in the DatabaseInstance object to refer to the parent instance of an instance and to refer the child instances of an instance. To specify as a parent instance during creation of an instance, the lsn and branch_time fields are optional. If not specified, the child instance will be created from the latest lsn of the parent. If both lsn and branch_time are specified, the lsn will be used to create the child instance.

branch_time: str | None = None

[Public Preview] Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance.

lsn: str | None = None

[Public Preview] User-specified WAL LSN of the ref database instance.

Input: For specifying the WAL LSN to create a child instance. Optional. Output: Only populated if provided as input to create a child instance.

name: str | None = None

[Public Preview] Name of the ref database instance.

classmethod from_dict(
value: dict,
) → Self
as_dict(
self,
) → dict
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 Permission
level: PermissionLevel

The permission level to apply. The allowed levels depend on the resource type.

group_name: str | None = None

The name of the group granted the permission level.

service_principal_name: str | None = None

The name of the service principal granted the permission level.

user_name: str | None = None

The name of the user granted the permission level.

classmethod from_dict(
value: dict,
) → Self
as_dict(
self,
) → dict
class PermissionLevel

Permission level

CAN_MANAGE = 'CAN_MANAGE'
CAN_RESTART = 'CAN_RESTART'
CAN_ATTACH_TO = 'CAN_ATTACH_TO'
IS_OWNER = 'IS_OWNER'
CAN_MANAGE_RUN = 'CAN_MANAGE_RUN'
CAN_VIEW = 'CAN_VIEW'
CAN_READ = 'CAN_READ'
CAN_RUN = 'CAN_RUN'
CAN_EDIT = 'CAN_EDIT'
CAN_USE = 'CAN_USE'
CAN_MANAGE_STAGING_VERSIONS = 'CAN_MANAGE_STAGING_VERSIONS'
CAN_MANAGE_PRODUCTION_VERSIONS = 'CAN_MANAGE_PRODUCTION_VERSIONS'
CAN_EDIT_METADATA = 'CAN_EDIT_METADATA'
CAN_VIEW_METADATA = 'CAN_VIEW_METADATA'
CAN_BIND = 'CAN_BIND'
CAN_QUERY = 'CAN_QUERY'
CAN_MONITOR = 'CAN_MONITOR'
CAN_CREATE = 'CAN_CREATE'
CAN_MONITOR_ONLY = 'CAN_MONITOR_ONLY'
CAN_CREATE_APP = 'CAN_CREATE_APP'