Skip to contents

Creates a new instance pool using idle and ready-to-use cloud instances.

Usage

create_instance_pool(
  client,
  instance_pool_name,
  node_type_id,
  aws_attributes = NULL,
  azure_attributes = NULL,
  custom_tags = NULL,
  disk_spec = NULL,
  enable_elastic_disk = NULL,
  gcp_attributes = NULL,
  idle_instance_autotermination_minutes = NULL,
  max_capacity = NULL,
  min_idle_instances = NULL,
  preloaded_docker_images = NULL,
  preloaded_spark_versions = NULL
)

instancePoolsCreate(
  client,
  instance_pool_name,
  node_type_id,
  aws_attributes = NULL,
  azure_attributes = NULL,
  custom_tags = NULL,
  disk_spec = NULL,
  enable_elastic_disk = NULL,
  gcp_attributes = NULL,
  idle_instance_autotermination_minutes = NULL,
  max_capacity = NULL,
  min_idle_instances = NULL,
  preloaded_docker_images = NULL,
  preloaded_spark_versions = NULL
)

Arguments

client

Required. Instance of DatabricksClient()

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.

aws_attributes

Attributes related to instance pools running on Amazon Web Services.

azure_attributes

Attributes related to instance pools running on Azure.

custom_tags

Additional tags for pool resources.

disk_spec

Defines the specification of the disks that will be attached to all spark containers.

enable_elastic_disk

Autoscaling Local Storage: when enabled, this instances in this pool will dynamically acquire additional disk space when its Spark workers are running low on disk space.

gcp_attributes

Attributes related to instance pools running on Google Cloud Platform.

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.

preloaded_docker_images

Custom Docker Image BYOC.

preloaded_spark_versions

A list containing at most one preloaded Spark image version for the pool.