Skip to content

Latest commit

History

History
34 lines (19 loc) 路 1.23 KB

named_properties.rst

File metadata and controls

34 lines (19 loc) 路 1.23 KB

Named properties support

Since version 0.2.2 you can also use dbx for name-based properties instead of providing ids.

The following properties are supported:

  • existing_cluster_name will be automatically replaced with existing_cluster_id
  • new_cluster.instance_pool_name will be automatically replaced with new_cluster.instance_pool_id
  • new_cluster.driver_instance_pool_name will be automatically replaced with new_cluster.driver_instance_pool_id
  • new_cluster.aws_attributes.instance_profile_name will be automatically replaced with new_cluster.aws_attributes.instance_profile_arn

By this simplification, you don't need to look-up for these id-based properties, you can simply provide the names.

Here are some examples in JSON and YAML:

.. tabs::

   .. tab:: JSON

      .. literalinclude:: ../../../tests/deployment-configs/05-json-with-named-properties.json
         :language: JSON

   .. tab:: YAML

      .. literalinclude:: ../../../tests/deployment-configs/05-yaml-with-named-properties.yaml
         :language: YAML


Note

Named properties are also supported for Jobs API 2.1 - simply provide them on the new_cluster level.