This article provides reference for keys supported by <DABS> configuration (YAML). See [_](/dev-tools/bundles/index.md).
For complete bundle examples, see [_](/dev-tools/bundles/resource-examples.md) and the [bundle-examples GitHub repository](https://github.com/databricks/bundle-examples).
## 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 [_](/dev-tools/bundles/settings.md#artifacts).
Artifact settings defined in the top level of the bundle configuration can be overridden in the `targets` mapping. See [_](/dev-tools/bundles/artifact-overrides.md).
```yaml
artifacts:
<artifact-name>:
<artifact-field-name>: <artifact-field-value>
```
.. list-table::
:header-rows: 1
* - Key
- Type
- Description
* - `build`
- String
- An optional set of non-default build commands to run locally before deployment.
* - `executable`
- String
- The executable type. Valid values are `bash`, `sh`, and `cmd`.
- The Git version control details that are associated with your bundle. For supported attributes see [_](/dev-tools/bundles/settings.md#git). See [_](#git).
- 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).
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.
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 [_](/dev-tools/bundles/settings.md#permissions) and [_](/dev-tools/bundles/permissions.md).
.. list-table::
:header-rows: 1
* - 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**
```yaml
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 [_](/dev-tools/bundles/deployment-modes.md#presets).
.. list-table::
:header-rows: 1
* - Key
- Type
- Description
* - `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.
- Whether or not PyDABs (Private Preview) is enabled
* - `import`
- Sequence
- The PyDABs project to import to discover resources, resource generator and mutators
* - `venv_path`
- String
- The Python virtual environment path
## python
**`Type: Map`**
Configures loading of Python code defined with 'databricks-bundles' package.
.. list-table::
:header-rows: 1
* - 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.
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 <DABS> supported resources, and resource definition reference, see [_](/dev-tools/bundles/resources.md).
```yaml
resources:
<resource-type>:
<resource-name>:
<resource-field-name>: <resource-field-value>
```
.. list-table::
:header-rows: 1
* - Key
- Type
- Description
* - `apps`
- Map
-
* - `clusters`
- Map
- The cluster definitions for the bundle, where each key is the name of a cluster. See [_](/dev-tools/bundles/resources.md#clusters)
* - `dashboards`
- Map
- The dashboard definitions for the bundle, where each key is the name of the dashboard. See [_](/dev-tools/bundles/resources.md#dashboards)
* - `experiments`
- Map
- The experiment definitions for the bundle, where each key is the name of the experiment. See [_](/dev-tools/bundles/resources.md#experiments)
* - `jobs`
- Map
- The job definitions for the bundle, where each key is the name of the job. See [_](/dev-tools/bundles/resources.md#jobs)
* - `model_serving_endpoints`
- Map
- The model serving endpoint definitions for the bundle, where each key is the name of the model serving endpoint. See [_](/dev-tools/bundles/resources.md#model_serving_endpoints)
* - `models`
- Map
- The model definitions for the bundle, where each key is the name of the model. See [_](/dev-tools/bundles/resources.md#models)
* - `pipelines`
- Map
- The pipeline definitions for the bundle, where each key is the name of the pipeline. See [_](/dev-tools/bundles/resources.md#pipelines)
* - `quality_monitors`
- Map
- The quality monitor definitions for the bundle, where each key is the name of the quality monitor. See [_](/dev-tools/bundles/resources.md#quality_monitors)
* - `registered_models`
- Map
- The registered model definitions for the bundle, where each key is the name of the <UC> registered model. See [_](/dev-tools/bundles/resources.md#registered_models)
* - `schemas`
- Map
- The schema definitions for the bundle, where each key is the name of the schema. See [_](/dev-tools/bundles/resources.md#schemas)
* - `volumes`
- Map
- The volume definitions for the bundle, where each key is the name of the volume. See [_](/dev-tools/bundles/resources.md#volumes)
## run_as
**`Type: Map`**
The identity to use when running <DABS> workflows. See [_](/dev-tools/bundles/run-as.md).
.. list-table::
:header-rows: 1
* - Key
- Type
- Description
* - `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.
## sync
**`Type: Map`**
The files and file paths to include or exclude in the bundle. See [_](/dev-tools/bundles/settings.md#sync).
.. list-table::
:header-rows: 1
* - 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 [_](/dev-tools/bundles/settings.md#targets)
- 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 [_](#lookup).
