Skip to content

reference.md

Latest commit

 

History

History
5526 lines (3559 loc) · 91.4 KB

reference.md

File metadata and controls

5526 lines (3559 loc) · 91.4 KB
Raw
description Configuration reference for databricks.yml
last_update
date
2026-06-09

Configuration reference

This article provides reference for keys supported by :re[DABS] configuration (YAML). See _.

For complete bundle examples, see _ and the bundle-examples GitHub repository.

artifacts

Type: Map

Defines the attributes to build artifacts, where each key is the name of the artifact, and the value is a Map that defines the artifact build settings. For information about the artifacts mapping, see _.

Artifact settings defined in the top level of the bundle configuration can be overridden in the targets mapping. See _.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>

:::list-table

    • Key
    • Type
    • Description
    • build
    • String
    • An optional set of build commands to run locally before deployment.
    • dynamic_version
    • Boolean
    • Whether to patch the wheel version dynamically based on the timestamp of the whl file. If this is set to true, new code can be deployed without having to update the version in setup.py or pyproject.toml. This setting is only valid when type is set to whl. See _.
    • executable
    • String
    • The executable type. Valid values are bash, sh, and cmd.
    • files
    • Sequence
    • The relative or absolute path to the built artifact files. See _.
    • path
    • String
    • The local path of the directory for the artifact.
    • type
    • String
    • Required if the artifact is a Python wheel. The type of the artifact. Valid values are whl and jar.

:::

Example

artifacts:
  default:
    type: whl
    build: poetry build
    path: .

artifacts.name.files

Type: Sequence

The relative or absolute path to the built artifact files.

:::list-table

    • Key
    • Type
    • Description
    • source
    • String
    • Required. The artifact source file.

:::

bundle

Type: Map

The bundle attributes when deploying to this target,

:::list-table

    • Key
    • Type
    • Description
    • cluster_id
    • String
    • The ID of a cluster to use to run the bundle. See _.
    • compute_id
    • String
    • Deprecated. The ID of the compute to use to run the bundle.
    • databricks_cli_version
    • String
    • The Databricks CLI version to use for the bundle. See _.
    • deployment
    • Map
    • The definition of the bundle deployment. For supported attributes see _. See _.
    • engine
    • String
    • The deployment engine to use. Valid values are terraform and direct. Takes priority over DATABRICKS_BUNDLE_ENGINE environment variable. Default is "terraform".
    • git
    • Map
    • The Git version control details that are associated with your bundle. For supported attributes see _. See _.
    • name
    • String
    • The name of the bundle.
    • uuid
    • String
    • Reserved. A Universally Unique Identifier (UUID) for the bundle that uniquely identifies the bundle in internal Databricks systems. This is generated when a bundle project is initialized using a Databricks template (using the databricks bundle init command).

:::

bundle.deployment

Type: Map

The definition of the bundle deployment. For supported attributes see _.

:::list-table

    • Key
    • Type
    • Description
    • fail_on_active_runs
    • Boolean
    • Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.
    • lock
    • Map
    • The deployment lock attributes. See _.

:::

bundle.deployment.lock

Type: Map

The deployment lock attributes.

:::list-table

    • Key
    • Type
    • Description
    • enabled
    • Boolean
    • Whether this lock is enabled.
    • force
    • Boolean
    • Whether to force this lock if it is enabled.

:::

bundle.git

Type: Map

The Git version control details that are associated with your bundle. For supported attributes see _.

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • The Git branch name. See _.
    • origin_url
    • String
    • The origin URL of the repository. See _.

:::

experimental

Type: Map

Defines attributes for experimental features.

:::list-table

    • Key
    • Type
    • Description
    • pydabs
    • Map
    • Deprecated: please use python instead
    • python
    • Map
    • Configures loading of Python code defined with 'databricks-bundles' package. See _.
    • python_wheel_wrapper
    • Boolean
    • Whether to use a Python wheel wrapper.
    • record_deployment_history
    • Boolean
    • Whether to record deployment history using the deployment metadata service (DMS), which tracks what changed across deployments.
    • scripts
    • Map
    • The commands to run.
    • skip_artifact_cleanup
    • Boolean
    • Determines whether to skip cleaning up the .internal folder
    • skip_name_prefix_for_schema
    • Boolean
    • Skip adding the prefix that is either set in presets.name_prefix or computed when mode: development is set, to the names of UC schemas defined in the bundle.
    • use_legacy_run_as
    • Boolean
    • Whether to use the legacy run_as behavior.

:::

experimental.python

Type: Map

Configures loading of Python code defined with 'databricks-bundles' package.

:::list-table

    • Key
    • Type
    • Description
    • mutators
    • Sequence
    • Mutators contains a list of fully qualified function paths to mutator functions. Example: ["my_project.mutators:add_default_cluster"]
    • resources
    • Sequence
    • Resources contains a list of fully qualified function paths to load resources defined in Python code. Example: ["my_project.resources:load_resources"]
    • venv_path
    • String
    • VEnvPath is path to the virtual environment. If enabled, Python code will execute within this environment. If disabled, it defaults to using the Python interpreter available in the current shell.

:::

include

Type: Sequence

Specifies a list of path globs that contain configuration files to include within the bundle. See _.

permissions

Type: Sequence

A Sequence that defines the permissions to apply to experiments, jobs, pipelines, and models defined in the bundle, where each item in the sequence is a permission for a specific entity.

See _ and _.

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

Example

permissions:
  - level: CAN_VIEW
    group_name: test-group
  - level: CAN_MANAGE
    user_name: someone@example.com
  - level: CAN_RUN
    service_principal_name: 123456-abcdef

presets

Type: Map

Defines bundle deployment presets. See _.

:::list-table

    • Key
    • Type
    • Description
    • artifacts_dynamic_version
    • Boolean
    • Whether to enable dynamic_version on all artifacts.
    • jobs_max_concurrent_runs
    • Integer
    • The maximum concurrent runs for a job.
    • name_prefix
    • String
    • The prefix for job runs of the bundle.
    • pipelines_development
    • Boolean
    • Whether pipeline deployments should be locked in development mode.
    • source_linked_deployment
    • Boolean
    • Whether to link the deployment to the bundle source.
    • tags
    • Map
    • The tags for the bundle deployment.
    • trigger_pause_status
    • String
    • A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED.

:::

python

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • mutators
    • Sequence
    • Mutators contains a list of fully qualified function paths to mutator functions. Example: ["my_project.mutators:add_default_cluster"]
    • resources
    • Sequence
    • Resources contains a list of fully qualified function paths to load resources defined in Python code. Example: ["my_project.resources:load_resources"]
    • venv_path
    • String
    • VEnvPath is path to the virtual environment. If enabled, Python code will execute within this environment. If disabled, it defaults to using the Python interpreter available in the current shell.

:::

resources

Type: Map

A Map that defines the resources for the bundle, where each key is the name of the resource, and the value is a Map that defines the resource. For more information about Declarative Automation Bundles supported resources, and resource definition reference, see _.

resources:
  <resource-type>:
    <resource-name>:
      <resource-field-name>: <resource-field-value>

:::list-table

    • Key
    • Type
    • Description
    • alerts
    • Map
    • See _.
    • apps
    • Map
    • The app resource defines a Databricks app. For information about Databricks Apps, see _. See _.
    • catalogs
    • Map
    • See _.
    • clusters
    • Map
    • The cluster definitions for the bundle, where each key is the name of a cluster. See _.
    • dashboards
    • Map
    • The dashboard definitions for the bundle, where each key is the name of the dashboard. See _. See _.
    • database_catalogs
    • Map
    • database_instances
    • Map
    • See _.
    • experiments
    • Map
    • The experiment definitions for the bundle, where each key is the name of the experiment. See _.
    • external_locations
    • Map
    • See _.
    • jobs
    • Map
    • The job definitions for the bundle, where each key is the name of the job. See _.
    • model_serving_endpoints
    • Map
    • The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See _.
    • models
    • Map
    • The model definitions for the bundle, where each key is the name of the model. See _.
    • pipelines
    • Map
    • The pipeline definitions for the bundle, where each key is the name of the pipeline. See _. See _.
    • postgres_branches
    • Map
    • See _.
    • postgres_catalogs
    • Map
    • The Postgres catalog definitions for the bundle, where each key is the name of the catalog. Each entry binds a Unity Catalog catalog to a Postgres database on a Lakebase Autoscaling branch. See _.
    • postgres_endpoints
    • Map
    • See _.
    • postgres_projects
    • Map
    • See _.
    • postgres_synced_tables
    • Map
    • The Postgres synced table definitions for the bundle, where each key is the name of the synced table. Each entry continuously replicates a Unity Catalog Delta source table into a Postgres table on a Lakebase Autoscaling instance. See _.
    • quality_monitors
    • Map
    • The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See _.
    • registered_models
    • Map
    • The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See _
    • schemas
    • Map
    • The schema definitions for the bundle, where each key is the name of the schema. See _.
    • secret_scopes
    • Map
    • The secret scope definitions for the bundle, where each key is the name of the secret scope. See _. See _.
    • sql_warehouses
    • Map
    • The SQL warehouse definitions for the bundle, where each key is the name of the warehouse. See _.
    • synced_database_tables
    • Map
    • See _.
    • vector_search_endpoints
    • Map
    • See _.
    • vector_search_indexes
    • Map
    • See _.
    • volumes
    • Map
    • The volume definitions for the bundle, where each key is the name of the volume. See _.

:::

resources.alerts

Type: Map

alerts:
  <alert-name>:
    <alert-field-name>: <alert-field-value>

:::list-table

    • Key
    • Type
    • Description
    • create_time
    • String
    • custom_description
    • String
    • custom_summary
    • String
    • display_name
    • String
    • effective_run_as
    • Map
    • See _.
    • evaluation
    • Map
    • See _.
    • file_path
    • String
    • id
    • String
    • lifecycle
    • Map
    • See _.
    • lifecycle_state
    • String
    • owner_user_name
    • String
    • parent_path
    • String
    • permissions
    • Sequence
    • See _.
    • query_text
    • String
    • run_as
    • Map
    • See _.
    • run_as_user_name
    • String
    • schedule
    • Map
    • See _.
    • update_time
    • String
    • warehouse_id
    • String

:::

resources.alerts.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.alerts.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

resources.apps

Type: Map

The app resource defines a Databricks app. For information about Databricks Apps, see _.

apps:
  <app-name>:
    <app-field-name>: <app-field-value>

:::list-table

    • Key
    • Type
    • Description
    • active_deployment
    • Map
    • See _.
    • app_status
    • Map
    • See _.
    • budget_policy_id
    • String
    • compute_max_instances
    • Integer
    • compute_min_instances
    • Integer
    • compute_size
    • String
    • compute_status
    • Map
    • See _.
    • config
    • Map
    • See _.
    • create_time
    • String
    • creator
    • String
    • default_source_code_path
    • String
    • description
    • String
    • effective_budget_policy_id
    • String
    • effective_usage_policy_id
    • String
    • effective_user_api_scopes
    • Sequence
    • git_repository
    • Map
    • See _.
    • git_source
    • Map
    • Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit) to use when deploying the app. Used in conjunction with git_repository to deploy code directly from git. The source_code_path within git_source specifies the relative path to the app code within the repository. See _.
    • id
    • String
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • oauth2_app_client_id
    • String
    • oauth2_app_integration_id
    • String
    • pending_deployment
    • Map
    • See _.
    • permissions
    • Sequence
    • See _.
    • resources
    • Sequence
    • See _.
    • service_principal_client_id
    • String
    • service_principal_id
    • Integer
    • service_principal_name
    • String
    • source_code_path
    • String
    • space
    • String
    • telemetry_export_destinations
    • Sequence
    • See _.
    • thumbnail_url
    • String
    • update_time
    • String
    • updater
    • String
    • url
    • String
    • usage_policy_id
    • String
    • user_api_scopes
    • Sequence

:::

resources.apps.name.config

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • command
    • Sequence
    • env
    • Sequence
    • See _.

:::

resources.apps.name.config.env

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • name
    • String
    • value
    • String
    • value_from
    • String

:::

resources.apps.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.
    • started
    • Boolean
    • Lifecycle setting to deploy the resource in started mode. Only supported for apps, clusters, and sql_warehouses in direct deployment mode.

:::

resources.apps.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • level
    • String
    • service_principal_name
    • String
    • user_name
    • String

:::

resources.catalogs

Type: Map

catalogs:
  <catalog-name>:
    <catalog-field-name>: <catalog-field-value>

:::list-table

    • Key
    • Type
    • Description
    • comment
    • String
    • connection_name
    • String
    • grants
    • Sequence
    • See _.
    • lifecycle
    • Map
    • See _.
    • managed_encryption_settings
    • Map
    • See _.
    • name
    • String
    • options
    • Map
    • properties
    • Map
    • provider_name
    • String
    • share_name
    • String
    • storage_root
    • String

:::

resources.catalogs.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.dashboards

Type: Map

The dashboard definitions for the bundle, where each key is the name of the dashboard. See _.

dashboards:
  <dashboard-name>:
    <dashboard-field-name>: <dashboard-field-value>

:::list-table

    • Key
    • Type
    • Description
    • create_time
    • String
    • dashboard_id
    • String
    • dataset_catalog
    • String
    • Sets the default catalog for all datasets in this dashboard. When set, this overrides the catalog specified in individual dataset definitions.
    • dataset_schema
    • String
    • Sets the default schema for all datasets in this dashboard. When set, this overrides the schema specified in individual dataset definitions.
    • display_name
    • String
    • embed_credentials
    • Boolean
    • etag
    • String
    • file_path
    • String
    • lifecycle
    • Map
    • See _.
    • lifecycle_state
    • String
    • parent_path
    • String
    • path
    • String
    • permissions
    • Sequence
    • See _.
    • serialized_dashboard
    • Any
    • update_time
    • String
    • warehouse_id
    • String

:::

resources.dashboards.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.dashboards.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

resources.database_instances

Type: Map

database_instances:
  <database_instance-name>:
    <database_instance-field-name>: <database_instance-field-value>

:::list-table

    • Key
    • Type
    • Description
    • capacity
    • String
    • child_instance_refs
    • Sequence
    • See _.
    • creation_time
    • String
    • creator
    • String
    • custom_tags
    • Sequence
    • See _.
    • effective_capacity
    • String
    • effective_custom_tags
    • Sequence
    • See _.
    • effective_enable_pg_native_login
    • Boolean
    • effective_enable_readable_secondaries
    • Boolean
    • effective_node_count
    • Integer
    • effective_retention_window_in_days
    • Integer
    • effective_stopped
    • Boolean
    • effective_usage_policy_id
    • String
    • enable_pg_native_login
    • Boolean
    • enable_readable_secondaries
    • Boolean
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • node_count
    • Integer
    • parent_instance_ref
    • Map
    • See _.
    • permissions
    • Sequence
    • See _.
    • pg_version
    • String
    • read_only_dns
    • String
    • read_write_dns
    • String
    • retention_window_in_days
    • Integer
    • state
    • String
    • stopped
    • Boolean
    • uid
    • String
    • usage_policy_id
    • String

:::

resources.database_instances.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.database_instances.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

resources.external_locations

Type: Map

external_locations:
  <external_location-name>:
    <external_location-field-name>: <external_location-field-value>

:::list-table

    • Key
    • Type
    • Description
    • comment
    • String
    • credential_name
    • String
    • effective_enable_file_events
    • Boolean
    • effective_file_event_queue
    • Map
    • See _.
    • enable_file_events
    • Boolean
    • encryption_details
    • Map
    • See _.
    • fallback
    • Boolean
    • file_event_queue
    • Map
    • See _.
    • grants
    • Sequence
    • See _.
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • read_only
    • Boolean
    • skip_validation
    • Boolean
    • url
    • String

:::

resources.external_locations.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.pipelines

Type: Map

The pipeline definitions for the bundle, where each key is the name of the pipeline. See _.

pipelines:
  <pipeline-name>:
    <pipeline-field-name>: <pipeline-field-value>

:::list-table

    • Key
    • Type
    • Description
    • allow_duplicate_names
    • Boolean
    • budget_policy_id
    • String
    • catalog
    • String
    • channel
    • String
    • clusters
    • Sequence
    • See _.
    • configuration
    • Map
    • continuous
    • Boolean
    • deployment
    • Map
    • See _.
    • development
    • Boolean
    • dry_run
    • Boolean
    • edition
    • String
    • environment
    • Map
    • See _.
    • event_log
    • Map
    • See _.
    • filters
    • Map
    • See _.
    • gateway_definition
    • Map
    • See _.
    • id
    • String
    • ingestion_definition
    • Map
    • See _.
    • libraries
    • Sequence
    • See _.
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • notifications
    • Sequence
    • See _.
    • parameters
    • Map
    • permissions
    • Sequence
    • See _.
    • photon
    • Boolean
    • restart_window
    • Map
    • See _.
    • root_path
    • String
    • run_as
    • Map
    • See _.
    • schema
    • String
    • serverless
    • Boolean
    • storage
    • String
    • tags
    • Map
    • target
    • String
    • trigger
    • Map
    • See _.
    • usage_policy_id
    • String

:::

resources.pipelines.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.pipelines.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • level
    • String
    • service_principal_name
    • String
    • user_name
    • String

:::

resources.postgres_branches

Type: Map

postgres_branches:
  <postgres_branche-name>:
    <postgres_branche-field-name>: <postgres_branche-field-value>

:::list-table

    • Key
    • Type
    • Description
    • branch_id
    • String
    • expire_time
    • Map
    • is_protected
    • Boolean
    • lifecycle
    • Map
    • See _.
    • no_expiry
    • Boolean
    • parent
    • String
    • replace_existing
    • Boolean
    • source_branch
    • String
    • source_branch_lsn
    • String
    • source_branch_time
    • Map
    • ttl
    • String

:::

resources.postgres_branches.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.postgres_catalogs

Type: Map

The Postgres catalog definitions for the bundle, where each key is the name of the catalog. Each entry binds a Unity Catalog catalog to a Postgres database on a Lakebase Autoscaling branch.

postgres_catalogs:
  <postgres_catalog-name>:
    <postgres_catalog-field-name>: <postgres_catalog-field-value>

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • catalog_id
    • String
    • create_database_if_missing
    • Boolean
    • lifecycle
    • Map
    • See _.
    • postgres_database
    • String

:::

resources.postgres_catalogs.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.postgres_endpoints

Type: Map

postgres_endpoints:
  <postgres_endpoint-name>:
    <postgres_endpoint-field-name>: <postgres_endpoint-field-value>

:::list-table

    • Key
    • Type
    • Description
    • autoscaling_limit_max_cu
    • Any
    • autoscaling_limit_min_cu
    • Any
    • disabled
    • Boolean
    • endpoint_id
    • String
    • endpoint_type
    • String
    • group
    • Map
    • See _.
    • lifecycle
    • Map
    • See _.
    • no_suspension
    • Boolean
    • parent
    • String
    • replace_existing
    • Boolean
    • settings
    • Map
    • See _.
    • suspend_timeout_duration
    • String

:::

resources.postgres_endpoints.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.postgres_projects

Type: Map

postgres_projects:
  <postgres_project-name>:
    <postgres_project-field-name>: <postgres_project-field-value>

:::list-table

    • Key
    • Type
    • Description
    • budget_policy_id
    • String
    • custom_tags
    • Sequence
    • See _.
    • default_branch
    • String
    • default_endpoint_settings
    • Map
    • See _.
    • display_name
    • String
    • enable_pg_native_login
    • Boolean
    • history_retention_duration
    • String
    • lifecycle
    • Map
    • See _.
    • permissions
    • Sequence
    • See _.
    • pg_version
    • Integer
    • project_id
    • String
    • purge_on_delete
    • Boolean

:::

resources.postgres_projects.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.postgres_projects.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

resources.postgres_synced_tables

Type: Map

The Postgres synced table definitions for the bundle, where each key is the name of the synced table. Each entry continuously replicates a Unity Catalog Delta source table into a Postgres table on a Lakebase Autoscaling instance.

postgres_synced_tables:
  <postgres_synced_table-name>:
    <postgres_synced_table-field-name>: <postgres_synced_table-field-value>

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • create_database_objects_if_missing
    • Boolean
    • existing_pipeline_id
    • String
    • lifecycle
    • Map
    • See _.
    • new_pipeline_spec
    • Map
    • See _.
    • postgres_database
    • String
    • primary_key_columns
    • Sequence
    • scheduling_policy
    • String
    • source_table_full_name
    • String
    • synced_table_id
    • String
    • timeseries_key
    • String

:::

resources.postgres_synced_tables.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.secret_scopes

Type: Map

The secret scope definitions for the bundle, where each key is the name of the secret scope. See _.

secret_scopes:
  <secret_scope-name>:
    <secret_scope-field-name>: <secret_scope-field-value>

:::list-table

    • Key
    • Type
    • Description
    • backend_type
    • String
    • The backend type the scope will be created with. If not specified, will default to DATABRICKS
    • keyvault_metadata
    • Map
    • The metadata for the secret scope if the backend_type is AZURE_KEYVAULT. See _.
    • lifecycle
    • Map
    • Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. See _.
    • name
    • String
    • Scope name requested by the user. Scope names are unique.
    • permissions
    • Sequence
    • The permissions to apply to the secret scope. Permissions are managed via secret scope ACLs. See _.

:::

resources.secret_scopes.name.lifecycle

Type: Map

Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.secret_scopes.name.permissions

Type: Sequence

The permissions to apply to the secret scope. Permissions are managed via secret scope ACLs.

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level. This field translates to a principal field in secret scope ACL.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The application ID of an active service principal. This field translates to a principal field in secret scope ACL.
    • user_name
    • String
    • The name of the user that has the permission set in level. This field translates to a principal field in secret scope ACL.

:::

resources.synced_database_tables

Type: Map

synced_database_tables:
  <synced_database_table-name>:
    <synced_database_table-field-name>: <synced_database_table-field-value>

:::list-table

    • Key
    • Type
    • Description
    • data_synchronization_status
    • Map
    • See _.
    • database_instance_name
    • String
    • effective_database_instance_name
    • String
    • effective_logical_database_name
    • String
    • lifecycle
    • Map
    • See _.
    • logical_database_name
    • String
    • name
    • String
    • spec
    • Map
    • See _.
    • unity_catalog_provisioning_state
    • String

:::

resources.synced_database_tables.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.vector_search_endpoints

Type: Map

vector_search_endpoints:
  <vector_search_endpoint-name>:
    <vector_search_endpoint-field-name>: <vector_search_endpoint-field-value>

:::list-table

    • Key
    • Type
    • Description
    • budget_policy_id
    • String
    • endpoint_type
    • String
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • permissions
    • Sequence
    • See _.
    • target_qps
    • Integer
    • usage_policy_id
    • String

:::

resources.vector_search_endpoints.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

resources.vector_search_endpoints.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

resources.vector_search_indexes

Type: Map

vector_search_indexes:
  <vector_search_indexe-name>:
    <vector_search_indexe-field-name>: <vector_search_indexe-field-value>

:::list-table

    • Key
    • Type
    • Description
    • delta_sync_index_spec
    • Map
    • See _.
    • direct_access_index_spec
    • Map
    • See _.
    • endpoint_name
    • String
    • grants
    • Sequence
    • See _.
    • index_subtype
    • String
    • index_type
    • String
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • primary_key
    • String

:::

resources.vector_search_indexes.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

run_as

Type: Map

The identity to use when running Declarative Automation Bundles resources. See _.

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • service_principal_name
    • String
    • The application ID of an active service principal. Setting this field requires the servicePrincipal/user role.
    • user_name
    • String
    • The email of an active workspace user. Non-admin users can only set this field to their own email.

:::

scripts

Type: Map

scripts:
  <script-name>:
    <script-field-name>: <script-field-value>

:::list-table

    • Key
    • Type
    • Description
    • content
    • String

:::

sync

Type: Map

The files and file paths to include or exclude in the bundle. See _.

:::list-table

    • Key
    • Type
    • Description
    • exclude
    • Sequence
    • A list of files or folders to exclude from the bundle.
    • include
    • Sequence
    • A list of files or folders to include in the bundle.
    • paths
    • Sequence
    • The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed.

:::

targets

Type: Map

Defines deployment targets for the bundle. See _

targets:
  <target-name>:
    <target-field-name>: <target-field-value>

:::list-table

    • Key
    • Type
    • Description
    • artifacts
    • Map
    • The artifacts to include in the target deployment. See _.
    • bundle
    • Map
    • The bundle attributes when deploying to this target. See _.
    • cluster_id
    • String
    • The ID of the cluster to use for this target.
    • compute_id
    • String
    • Deprecated: please use cluster_id instead
    • default
    • Boolean
    • Whether this target is the default target.
    • git
    • Map
    • The Git version control settings for the target. See _.
    • mode
    • String
    • The deployment mode for the target. Valid values are development or production. See _.
    • permissions
    • Sequence
    • The permissions for deploying and running the bundle in the target. See _.
    • presets
    • Map
    • The deployment presets for the target. See _.
    • resources
    • Map
    • The resource definitions for the target. See _.
    • run_as
    • Map
    • The identity to use to run the bundle, see _. See _.
    • sync
    • Map
    • The local paths to sync to the target workspace when a bundle is run or deployed. See _.
    • variables
    • Map
    • The custom variable definitions for the target. See _.
    • workspace
    • Map
    • The Databricks workspace for the target. See _.

:::

targets.name.artifacts

Type: Map

The artifacts to include in the target deployment.

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>

:::list-table

    • Key
    • Type
    • Description
    • build
    • String
    • An optional set of build commands to run locally before deployment.
    • dynamic_version
    • Boolean
    • Whether to patch the wheel version dynamically based on the timestamp of the whl file. If this is set to true, new code can be deployed without having to update the version in setup.py or pyproject.toml. This setting is only valid when type is set to whl. See _.
    • executable
    • String
    • The executable type. Valid values are bash, sh, and cmd.
    • files
    • Sequence
    • The relative or absolute path to the built artifact files. See _.
    • path
    • String
    • The local path of the directory for the artifact.
    • type
    • String
    • Required if the artifact is a Python wheel. The type of the artifact. Valid values are whl and jar.

:::

targets.name.artifacts.name.files

Type: Sequence

The relative or absolute path to the built artifact files.

:::list-table

    • Key
    • Type
    • Description
    • source
    • String
    • Required. The artifact source file.

:::

targets.name.bundle

Type: Map

The bundle attributes when deploying to this target.

:::list-table

    • Key
    • Type
    • Description
    • cluster_id
    • String
    • The ID of a cluster to use to run the bundle. See _.
    • compute_id
    • String
    • Deprecated. The ID of the compute to use to run the bundle.
    • databricks_cli_version
    • String
    • The Databricks CLI version to use for the bundle. See _.
    • deployment
    • Map
    • The definition of the bundle deployment. For supported attributes see _. See _.
    • engine
    • String
    • The deployment engine to use. Valid values are terraform and direct. Takes priority over DATABRICKS_BUNDLE_ENGINE environment variable. Default is "terraform".
    • git
    • Map
    • The Git version control details that are associated with your bundle. For supported attributes see _. See _.
    • name
    • String
    • The name of the bundle.
    • uuid
    • String
    • Reserved. A Universally Unique Identifier (UUID) for the bundle that uniquely identifies the bundle in internal Databricks systems. This is generated when a bundle project is initialized using a Databricks template (using the databricks bundle init command).

:::

targets.name.bundle.deployment

Type: Map

The definition of the bundle deployment. For supported attributes see _.

:::list-table

    • Key
    • Type
    • Description
    • fail_on_active_runs
    • Boolean
    • Whether to fail on active runs. If this is set to true a deployment that is running can be interrupted.
    • lock
    • Map
    • The deployment lock attributes. See _.

:::

targets.name.bundle.deployment.lock

Type: Map

The deployment lock attributes.

:::list-table

    • Key
    • Type
    • Description
    • enabled
    • Boolean
    • Whether this lock is enabled.
    • force
    • Boolean
    • Whether to force this lock if it is enabled.

:::

targets.name.bundle.git

Type: Map

The Git version control details that are associated with your bundle. For supported attributes see _.

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • The Git branch name. See _.
    • origin_url
    • String
    • The origin URL of the repository. See _.

:::

targets.name.git

Type: Map

The Git version control settings for the target.

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • The Git branch name. See _.
    • origin_url
    • String
    • The origin URL of the repository. See _.

:::

targets.name.permissions

Type: Sequence

The permissions for deploying and running the bundle in the target.

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

targets.name.presets

Type: Map

The deployment presets for the target.

:::list-table

    • Key
    • Type
    • Description
    • artifacts_dynamic_version
    • Boolean
    • Whether to enable dynamic_version on all artifacts.
    • jobs_max_concurrent_runs
    • Integer
    • The maximum concurrent runs for a job.
    • name_prefix
    • String
    • The prefix for job runs of the bundle.
    • pipelines_development
    • Boolean
    • Whether pipeline deployments should be locked in development mode.
    • source_linked_deployment
    • Boolean
    • Whether to link the deployment to the bundle source.
    • tags
    • Map
    • The tags for the bundle deployment.
    • trigger_pause_status
    • String
    • A pause status to apply to all job triggers and schedules. Valid values are PAUSED or UNPAUSED.

:::

targets.name.resources

Type: Map

The resource definitions for the target.

:::list-table

    • Key
    • Type
    • Description
    • alerts
    • Map
    • See _.
    • apps
    • Map
    • The app resource defines a Databricks app. For information about Databricks Apps, see _. See _.
    • catalogs
    • Map
    • See _.
    • clusters
    • Map
    • The cluster definitions for the bundle, where each key is the name of a cluster. See _.
    • dashboards
    • Map
    • The dashboard definitions for the bundle, where each key is the name of the dashboard. See _. See _.
    • database_catalogs
    • Map
    • database_instances
    • Map
    • See _.
    • experiments
    • Map
    • The experiment definitions for the bundle, where each key is the name of the experiment. See _.
    • external_locations
    • Map
    • See _.
    • jobs
    • Map
    • The job definitions for the bundle, where each key is the name of the job. See _.
    • model_serving_endpoints
    • Map
    • The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See _.
    • models
    • Map
    • The model definitions for the bundle, where each key is the name of the model. See _.
    • pipelines
    • Map
    • The pipeline definitions for the bundle, where each key is the name of the pipeline. See _. See _.
    • postgres_branches
    • Map
    • See _.
    • postgres_catalogs
    • Map
    • The Postgres catalog definitions for the bundle, where each key is the name of the catalog. Each entry binds a Unity Catalog catalog to a Postgres database on a Lakebase Autoscaling branch. See _.
    • postgres_endpoints
    • Map
    • See _.
    • postgres_projects
    • Map
    • See _.
    • postgres_synced_tables
    • Map
    • The Postgres synced table definitions for the bundle, where each key is the name of the synced table. Each entry continuously replicates a Unity Catalog Delta source table into a Postgres table on a Lakebase Autoscaling instance. See _.
    • quality_monitors
    • Map
    • The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See _.
    • registered_models
    • Map
    • The registered model definitions for the bundle, where each key is the name of the Unity Catalog registered model. See _
    • schemas
    • Map
    • The schema definitions for the bundle, where each key is the name of the schema. See _.
    • secret_scopes
    • Map
    • The secret scope definitions for the bundle, where each key is the name of the secret scope. See _. See _.
    • sql_warehouses
    • Map
    • The SQL warehouse definitions for the bundle, where each key is the name of the warehouse. See _.
    • synced_database_tables
    • Map
    • See _.
    • vector_search_endpoints
    • Map
    • See _.
    • vector_search_indexes
    • Map
    • See _.
    • volumes
    • Map
    • The volume definitions for the bundle, where each key is the name of the volume. See _.

:::

targets.name.resources.alerts

Type: Map

alerts:
  <alert-name>:
    <alert-field-name>: <alert-field-value>

:::list-table

    • Key
    • Type
    • Description
    • create_time
    • String
    • custom_description
    • String
    • custom_summary
    • String
    • display_name
    • String
    • effective_run_as
    • Map
    • See _.
    • evaluation
    • Map
    • See _.
    • file_path
    • String
    • id
    • String
    • lifecycle
    • Map
    • See _.
    • lifecycle_state
    • String
    • owner_user_name
    • String
    • parent_path
    • String
    • permissions
    • Sequence
    • See _.
    • query_text
    • String
    • run_as
    • Map
    • See _.
    • run_as_user_name
    • String
    • schedule
    • Map
    • See _.
    • update_time
    • String
    • warehouse_id
    • String

:::

targets.name.resources.alerts.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.alerts.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

targets.name.resources.apps

Type: Map

The app resource defines a Databricks app. For information about Databricks Apps, see _.

apps:
  <app-name>:
    <app-field-name>: <app-field-value>

:::list-table

    • Key
    • Type
    • Description
    • active_deployment
    • Map
    • See _.
    • app_status
    • Map
    • See _.
    • budget_policy_id
    • String
    • compute_max_instances
    • Integer
    • compute_min_instances
    • Integer
    • compute_size
    • String
    • compute_status
    • Map
    • See _.
    • config
    • Map
    • See _.
    • create_time
    • String
    • creator
    • String
    • default_source_code_path
    • String
    • description
    • String
    • effective_budget_policy_id
    • String
    • effective_usage_policy_id
    • String
    • effective_user_api_scopes
    • Sequence
    • git_repository
    • Map
    • See _.
    • git_source
    • Map
    • Git source configuration for app deployments. Specifies which git reference (branch, tag, or commit) to use when deploying the app. Used in conjunction with git_repository to deploy code directly from git. The source_code_path within git_source specifies the relative path to the app code within the repository. See _.
    • id
    • String
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • oauth2_app_client_id
    • String
    • oauth2_app_integration_id
    • String
    • pending_deployment
    • Map
    • See _.
    • permissions
    • Sequence
    • See _.
    • resources
    • Sequence
    • See _.
    • service_principal_client_id
    • String
    • service_principal_id
    • Integer
    • service_principal_name
    • String
    • source_code_path
    • String
    • space
    • String
    • telemetry_export_destinations
    • Sequence
    • See _.
    • thumbnail_url
    • String
    • update_time
    • String
    • updater
    • String
    • url
    • String
    • usage_policy_id
    • String
    • user_api_scopes
    • Sequence

:::

targets.name.resources.apps.name.config

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • command
    • Sequence
    • env
    • Sequence
    • See _.

:::

targets.name.resources.apps.name.config.env

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • name
    • String
    • value
    • String
    • value_from
    • String

:::

targets.name.resources.apps.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.
    • started
    • Boolean
    • Lifecycle setting to deploy the resource in started mode. Only supported for apps, clusters, and sql_warehouses in direct deployment mode.

:::

targets.name.resources.apps.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • level
    • String
    • service_principal_name
    • String
    • user_name
    • String

:::

targets.name.resources.catalogs

Type: Map

catalogs:
  <catalog-name>:
    <catalog-field-name>: <catalog-field-value>

:::list-table

    • Key
    • Type
    • Description
    • comment
    • String
    • connection_name
    • String
    • grants
    • Sequence
    • See _.
    • lifecycle
    • Map
    • See _.
    • managed_encryption_settings
    • Map
    • See _.
    • name
    • String
    • options
    • Map
    • properties
    • Map
    • provider_name
    • String
    • share_name
    • String
    • storage_root
    • String

:::

targets.name.resources.catalogs.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.dashboards

Type: Map

The dashboard definitions for the bundle, where each key is the name of the dashboard. See _.

dashboards:
  <dashboard-name>:
    <dashboard-field-name>: <dashboard-field-value>

:::list-table

    • Key
    • Type
    • Description
    • create_time
    • String
    • dashboard_id
    • String
    • dataset_catalog
    • String
    • Sets the default catalog for all datasets in this dashboard. When set, this overrides the catalog specified in individual dataset definitions.
    • dataset_schema
    • String
    • Sets the default schema for all datasets in this dashboard. When set, this overrides the schema specified in individual dataset definitions.
    • display_name
    • String
    • embed_credentials
    • Boolean
    • etag
    • String
    • file_path
    • String
    • lifecycle
    • Map
    • See _.
    • lifecycle_state
    • String
    • parent_path
    • String
    • path
    • String
    • permissions
    • Sequence
    • See _.
    • serialized_dashboard
    • Any
    • update_time
    • String
    • warehouse_id
    • String

:::

targets.name.resources.dashboards.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.dashboards.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

targets.name.resources.database_instances

Type: Map

database_instances:
  <database_instance-name>:
    <database_instance-field-name>: <database_instance-field-value>

:::list-table

    • Key
    • Type
    • Description
    • capacity
    • String
    • child_instance_refs
    • Sequence
    • See _.
    • creation_time
    • String
    • creator
    • String
    • custom_tags
    • Sequence
    • See _.
    • effective_capacity
    • String
    • effective_custom_tags
    • Sequence
    • See _.
    • effective_enable_pg_native_login
    • Boolean
    • effective_enable_readable_secondaries
    • Boolean
    • effective_node_count
    • Integer
    • effective_retention_window_in_days
    • Integer
    • effective_stopped
    • Boolean
    • effective_usage_policy_id
    • String
    • enable_pg_native_login
    • Boolean
    • enable_readable_secondaries
    • Boolean
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • node_count
    • Integer
    • parent_instance_ref
    • Map
    • See _.
    • permissions
    • Sequence
    • See _.
    • pg_version
    • String
    • read_only_dns
    • String
    • read_write_dns
    • String
    • retention_window_in_days
    • Integer
    • state
    • String
    • stopped
    • Boolean
    • uid
    • String
    • usage_policy_id
    • String

:::

targets.name.resources.database_instances.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.database_instances.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

targets.name.resources.external_locations

Type: Map

external_locations:
  <external_location-name>:
    <external_location-field-name>: <external_location-field-value>

:::list-table

    • Key
    • Type
    • Description
    • comment
    • String
    • credential_name
    • String
    • effective_enable_file_events
    • Boolean
    • effective_file_event_queue
    • Map
    • See _.
    • enable_file_events
    • Boolean
    • encryption_details
    • Map
    • See _.
    • fallback
    • Boolean
    • file_event_queue
    • Map
    • See _.
    • grants
    • Sequence
    • See _.
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • read_only
    • Boolean
    • skip_validation
    • Boolean
    • url
    • String

:::

targets.name.resources.external_locations.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.pipelines

Type: Map

The pipeline definitions for the bundle, where each key is the name of the pipeline. See _.

pipelines:
  <pipeline-name>:
    <pipeline-field-name>: <pipeline-field-value>

:::list-table

    • Key
    • Type
    • Description
    • allow_duplicate_names
    • Boolean
    • budget_policy_id
    • String
    • catalog
    • String
    • channel
    • String
    • clusters
    • Sequence
    • See _.
    • configuration
    • Map
    • continuous
    • Boolean
    • deployment
    • Map
    • See _.
    • development
    • Boolean
    • dry_run
    • Boolean
    • edition
    • String
    • environment
    • Map
    • See _.
    • event_log
    • Map
    • See _.
    • filters
    • Map
    • See _.
    • gateway_definition
    • Map
    • See _.
    • id
    • String
    • ingestion_definition
    • Map
    • See _.
    • libraries
    • Sequence
    • See _.
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • notifications
    • Sequence
    • See _.
    • parameters
    • Map
    • permissions
    • Sequence
    • See _.
    • photon
    • Boolean
    • restart_window
    • Map
    • See _.
    • root_path
    • String
    • run_as
    • Map
    • See _.
    • schema
    • String
    • serverless
    • Boolean
    • storage
    • String
    • tags
    • Map
    • target
    • String
    • trigger
    • Map
    • See _.
    • usage_policy_id
    • String

:::

targets.name.resources.pipelines.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.pipelines.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • level
    • String
    • service_principal_name
    • String
    • user_name
    • String

:::

targets.name.resources.postgres_branches

Type: Map

postgres_branches:
  <postgres_branche-name>:
    <postgres_branche-field-name>: <postgres_branche-field-value>

:::list-table

    • Key
    • Type
    • Description
    • branch_id
    • String
    • expire_time
    • Map
    • is_protected
    • Boolean
    • lifecycle
    • Map
    • See _.
    • no_expiry
    • Boolean
    • parent
    • String
    • replace_existing
    • Boolean
    • source_branch
    • String
    • source_branch_lsn
    • String
    • source_branch_time
    • Map
    • ttl
    • String

:::

targets.name.resources.postgres_branches.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.postgres_catalogs

Type: Map

The Postgres catalog definitions for the bundle, where each key is the name of the catalog. Each entry binds a Unity Catalog catalog to a Postgres database on a Lakebase Autoscaling branch.

postgres_catalogs:
  <postgres_catalog-name>:
    <postgres_catalog-field-name>: <postgres_catalog-field-value>

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • catalog_id
    • String
    • create_database_if_missing
    • Boolean
    • lifecycle
    • Map
    • See _.
    • postgres_database
    • String

:::

targets.name.resources.postgres_catalogs.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.postgres_endpoints

Type: Map

postgres_endpoints:
  <postgres_endpoint-name>:
    <postgres_endpoint-field-name>: <postgres_endpoint-field-value>

:::list-table

    • Key
    • Type
    • Description
    • autoscaling_limit_max_cu
    • Any
    • autoscaling_limit_min_cu
    • Any
    • disabled
    • Boolean
    • endpoint_id
    • String
    • endpoint_type
    • String
    • group
    • Map
    • See _.
    • lifecycle
    • Map
    • See _.
    • no_suspension
    • Boolean
    • parent
    • String
    • replace_existing
    • Boolean
    • settings
    • Map
    • See _.
    • suspend_timeout_duration
    • String

:::

targets.name.resources.postgres_endpoints.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.postgres_projects

Type: Map

postgres_projects:
  <postgres_project-name>:
    <postgres_project-field-name>: <postgres_project-field-value>

:::list-table

    • Key
    • Type
    • Description
    • budget_policy_id
    • String
    • custom_tags
    • Sequence
    • See _.
    • default_branch
    • String
    • default_endpoint_settings
    • Map
    • See _.
    • display_name
    • String
    • enable_pg_native_login
    • Boolean
    • history_retention_duration
    • String
    • lifecycle
    • Map
    • See _.
    • permissions
    • Sequence
    • See _.
    • pg_version
    • Integer
    • project_id
    • String
    • purge_on_delete
    • Boolean

:::

targets.name.resources.postgres_projects.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.postgres_projects.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

targets.name.resources.postgres_synced_tables

Type: Map

The Postgres synced table definitions for the bundle, where each key is the name of the synced table. Each entry continuously replicates a Unity Catalog Delta source table into a Postgres table on a Lakebase Autoscaling instance.

postgres_synced_tables:
  <postgres_synced_table-name>:
    <postgres_synced_table-field-name>: <postgres_synced_table-field-value>

:::list-table

    • Key
    • Type
    • Description
    • branch
    • String
    • create_database_objects_if_missing
    • Boolean
    • existing_pipeline_id
    • String
    • lifecycle
    • Map
    • See _.
    • new_pipeline_spec
    • Map
    • See _.
    • postgres_database
    • String
    • primary_key_columns
    • Sequence
    • scheduling_policy
    • String
    • source_table_full_name
    • String
    • synced_table_id
    • String
    • timeseries_key
    • String

:::

targets.name.resources.postgres_synced_tables.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.secret_scopes

Type: Map

The secret scope definitions for the bundle, where each key is the name of the secret scope. See _.

secret_scopes:
  <secret_scope-name>:
    <secret_scope-field-name>: <secret_scope-field-value>

:::list-table

    • Key
    • Type
    • Description
    • backend_type
    • String
    • The backend type the scope will be created with. If not specified, will default to DATABRICKS
    • keyvault_metadata
    • Map
    • The metadata for the secret scope if the backend_type is AZURE_KEYVAULT. See _.
    • lifecycle
    • Map
    • Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed. See _.
    • name
    • String
    • Scope name requested by the user. Scope names are unique.
    • permissions
    • Sequence
    • The permissions to apply to the secret scope. Permissions are managed via secret scope ACLs. See _.

:::

targets.name.resources.secret_scopes.name.lifecycle

Type: Map

Lifecycle is a struct that contains the lifecycle settings for a resource. It controls the behavior of the resource when it is deployed or destroyed.

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.secret_scopes.name.permissions

Type: Sequence

The permissions to apply to the secret scope. Permissions are managed via secret scope ACLs.

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level. This field translates to a principal field in secret scope ACL.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The application ID of an active service principal. This field translates to a principal field in secret scope ACL.
    • user_name
    • String
    • The name of the user that has the permission set in level. This field translates to a principal field in secret scope ACL.

:::

targets.name.resources.synced_database_tables

Type: Map

synced_database_tables:
  <synced_database_table-name>:
    <synced_database_table-field-name>: <synced_database_table-field-value>

:::list-table

    • Key
    • Type
    • Description
    • data_synchronization_status
    • Map
    • See _.
    • database_instance_name
    • String
    • effective_database_instance_name
    • String
    • effective_logical_database_name
    • String
    • lifecycle
    • Map
    • See _.
    • logical_database_name
    • String
    • name
    • String
    • spec
    • Map
    • See _.
    • unity_catalog_provisioning_state
    • String

:::

targets.name.resources.synced_database_tables.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.vector_search_endpoints

Type: Map

vector_search_endpoints:
  <vector_search_endpoint-name>:
    <vector_search_endpoint-field-name>: <vector_search_endpoint-field-value>

:::list-table

    • Key
    • Type
    • Description
    • budget_policy_id
    • String
    • endpoint_type
    • String
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • permissions
    • Sequence
    • See _.
    • target_qps
    • Integer
    • usage_policy_id
    • String

:::

targets.name.resources.vector_search_endpoints.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.resources.vector_search_endpoints.name.permissions

Type: Sequence

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • The name of the group that has the permission set in level.
    • level
    • String
    • The allowed permission for user, group, service principal defined for this permission.
    • service_principal_name
    • String
    • The name of the service principal that has the permission set in level.
    • user_name
    • String
    • The name of the user that has the permission set in level.

:::

targets.name.resources.vector_search_indexes

Type: Map

vector_search_indexes:
  <vector_search_indexe-name>:
    <vector_search_indexe-field-name>: <vector_search_indexe-field-value>

:::list-table

    • Key
    • Type
    • Description
    • delta_sync_index_spec
    • Map
    • See _.
    • direct_access_index_spec
    • Map
    • See _.
    • endpoint_name
    • String
    • grants
    • Sequence
    • See _.
    • index_subtype
    • String
    • index_type
    • String
    • lifecycle
    • Map
    • See _.
    • name
    • String
    • primary_key
    • String

:::

targets.name.resources.vector_search_indexes.name.lifecycle

Type: Map

:::list-table

    • Key
    • Type
    • Description
    • prevent_destroy
    • Boolean
    • Lifecycle setting to prevent the resource from being destroyed.

:::

targets.name.run_as

Type: Map

The identity to use to run the bundle, see _.

:::list-table

    • Key
    • Type
    • Description
    • group_name
    • String
    • service_principal_name
    • String
    • The application ID of an active service principal. Setting this field requires the servicePrincipal/user role.
    • user_name
    • String
    • The email of an active workspace user. Non-admin users can only set this field to their own email.

:::

targets.name.sync

Type: Map

The local paths to sync to the target workspace when a bundle is run or deployed.

:::list-table

    • Key
    • Type
    • Description
    • exclude
    • Sequence
    • A list of files or folders to exclude from the bundle.
    • include
    • Sequence
    • A list of files or folders to include in the bundle.
    • paths
    • Sequence
    • The local folder paths, which can be outside the bundle root, to synchronize to the workspace when the bundle is deployed.

:::

targets.name.variables

Type: Map

The custom variable definitions for the target.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

:::list-table

    • Key
    • Type
    • Description
    • default
    • Any
    • The default value for the variable.
    • description
    • String
    • The description of the variable.
    • lookup
    • Map
    • The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID. See _.
    • type
    • String
    • The type of the variable.

:::

targets.name.variables.name.lookup

Type: Map

The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.

:::list-table

    • Key
    • Type
    • Description
    • alert
    • String
    • The name of the alert for which to retrieve an ID.
    • cluster
    • String
    • The name of the cluster for which to retrieve an ID.
    • cluster_policy
    • String
    • The name of the cluster_policy for which to retrieve an ID.
    • dashboard
    • String
    • The name of the dashboard for which to retrieve an ID.
    • instance_pool
    • String
    • The name of the instance_pool for which to retrieve an ID.
    • job
    • String
    • The name of the job for which to retrieve an ID.
    • metastore
    • String
    • The name of the metastore for which to retrieve an ID.
    • notification_destination
    • String
    • The name of the notification_destination for which to retrieve an ID.
    • pipeline
    • String
    • The name of the pipeline for which to retrieve an ID.
    • query
    • String
    • The name of the query for which to retrieve an ID.
    • service_principal
    • String
    • The name of the service_principal for which to retrieve an ID.
    • warehouse
    • String
    • The name of the warehouse for which to retrieve an ID.

:::

targets.name.workspace

Type: Map

The Databricks workspace for the target.

:::list-table

    • Key
    • Type
    • Description
    • account_id
    • String
    • The Databricks account ID.
    • artifact_path
    • String
    • The artifact path to use within the workspace for both deployments and job runs
    • auth_type
    • String
    • The authentication type.
    • azure_client_id
    • String
    • The Azure client ID
    • azure_environment
    • String
    • The Azure environment
    • azure_login_app_id
    • String
    • The Azure login app ID
    • azure_tenant_id
    • String
    • The Azure tenant ID
    • azure_use_msi
    • Boolean
    • Whether to use MSI for Azure
    • azure_workspace_resource_id
    • String
    • The Azure workspace resource ID
    • client_id
    • String
    • The client ID for the workspace
    • experimental_is_unified_host
    • Boolean
    • Deprecated: no-op. Unified hosts are now detected automatically from /.well-known/databricks-config. Retained for schema compatibility with existing databricks.yml files.
    • file_path
    • String
    • The file path to use within the workspace for both deployments and job runs
    • google_service_account
    • String
    • The Google service account name
    • host
    • String
    • The Databricks workspace host URL
    • profile
    • String
    • The Databricks workspace profile name
    • resource_path
    • String
    • The workspace resource path
    • root_path
    • String
    • The Databricks workspace root path
    • state_path
    • String
    • The workspace state path
    • workspace_id
    • String
    • The Databricks workspace ID

:::

variables

Type: Map

Defines a custom variable for the bundle. See _.

variables:
  <variable-name>:
    <variable-field-name>: <variable-field-value>

:::list-table

    • Key
    • Type
    • Description
    • default
    • Any
    • The default value for the variable.
    • description
    • String
    • The description of the variable
    • lookup
    • Map
    • The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID. See _.
    • type
    • String
    • The type of the variable.

:::

variables.name.lookup

Type: Map

The name of the alert, cluster_policy, cluster, dashboard, instance_pool, job, metastore, pipeline, query, service_principal, or warehouse object for which to retrieve an ID.

:::list-table

    • Key
    • Type
    • Description
    • alert
    • String
    • The name of the alert for which to retrieve an ID.
    • cluster
    • String
    • The name of the cluster for which to retrieve an ID.
    • cluster_policy
    • String
    • The name of the cluster_policy for which to retrieve an ID.
    • dashboard
    • String
    • The name of the dashboard for which to retrieve an ID.
    • instance_pool
    • String
    • The name of the instance_pool for which to retrieve an ID.
    • job
    • String
    • The name of the job for which to retrieve an ID.
    • metastore
    • String
    • The name of the metastore for which to retrieve an ID.
    • notification_destination
    • String
    • The name of the notification_destination for which to retrieve an ID.
    • pipeline
    • String
    • The name of the pipeline for which to retrieve an ID.
    • query
    • String
    • The name of the query for which to retrieve an ID.
    • service_principal
    • String
    • The name of the service_principal for which to retrieve an ID.
    • warehouse
    • String
    • The name of the warehouse for which to retrieve an ID.

:::

workspace

Type: Map

Defines the Databricks workspace for the bundle. See _.

:::list-table

    • Key
    • Type
    • Description
    • account_id
    • String
    • The Databricks account ID.
    • artifact_path
    • String
    • The artifact path to use within the workspace for both deployments and job runs
    • auth_type
    • String
    • The authentication type.
    • azure_client_id
    • String
    • The Azure client ID
    • azure_environment
    • String
    • The Azure environment
    • azure_login_app_id
    • String
    • The Azure login app ID
    • azure_tenant_id
    • String
    • The Azure tenant ID
    • azure_use_msi
    • Boolean
    • Whether to use MSI for Azure
    • azure_workspace_resource_id
    • String
    • The Azure workspace resource ID
    • client_id
    • String
    • The client ID for the workspace
    • experimental_is_unified_host
    • Boolean
    • Deprecated: no-op. Unified hosts are now detected automatically from /.well-known/databricks-config. Retained for schema compatibility with existing databricks.yml files.
    • file_path
    • String
    • The file path to use within the workspace for both deployments and job runs
    • google_service_account
    • String
    • The Google service account name
    • host
    • String
    • The Databricks workspace host URL
    • profile
    • String
    • The Databricks workspace profile name
    • resource_path
    • String
    • The workspace resource path
    • root_path
    • String
    • The Databricks workspace root path
    • state_path
    • String
    • The workspace state path
    • workspace_id
    • String
    • The Databricks workspace ID

:::