Skip to contents

Edit an existing instance pool.

edit_instance_pool.Rd

Modifies the configuration of an existing instance pool.

Usage

edit_instance_pool(
  client,
  instance_pool_id,
  instance_pool_name,
  node_type_id,
  custom_tags = NULL,
  idle_instance_autotermination_minutes = NULL,
  max_capacity = NULL,
  min_idle_instances = NULL
)

instancePoolsEdit(
  client,
  instance_pool_id,
  instance_pool_name,
  node_type_id,
  custom_tags = NULL,
  idle_instance_autotermination_minutes = NULL,
  max_capacity = NULL,
  min_idle_instances = NULL
)

Arguments

client

Required. Instance of DatabricksClient()

instance_pool_id

Required. Instance pool ID.

instance_pool_name

Required. Pool name requested by the user.

node_type_id

Required. This field encodes, through a single value, the resources available to each of the Spark nodes in this cluster.

custom_tags

Additional tags for pool resources.

idle_instance_autotermination_minutes

Automatically terminates the extra instances in the pool cache after they are inactive for this time in minutes if min_idle_instances requirement is already met.

max_capacity

Maximum number of outstanding instances to keep in the pool, including both instances used by clusters and idle instances.

min_idle_instances

Minimum number of idle instances to keep in the instance pool.