getInstancePool

Databricks v1.92.0, May 12 26

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Viewing docs for Databricks v1.92.0
published on Tuesday, May 12, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-databricks

Example Usage

Referring to an instance pool by name:

import * as pulumi from "@pulumi/pulumi";
import * as databricks from "@pulumi/databricks";

const pool = databricks.getInstancePool({
    name: "All spot",
});
const myCluster = new databricks.Cluster("my_cluster", {instancePoolId: pool.then(pool => pool.id)});

import pulumi
import pulumi_databricks as databricks

pool = databricks.get_instance_pool(name="All spot")
my_cluster = databricks.Cluster("my_cluster", instance_pool_id=pool.id)

package main

import (
	"github.com/pulumi/pulumi-databricks/sdk/go/databricks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pool, err := databricks.GetInstancePool(ctx, &databricks.LookupInstancePoolArgs{
			Name: "All spot",
		}, nil)
		if err != nil {
			return err
		}
		_, err = databricks.NewCluster(ctx, "my_cluster", &databricks.ClusterArgs{
			InstancePoolId: pulumi.String(pulumi.String(pool.Id)),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Databricks = Pulumi.Databricks;

return await Deployment.RunAsync(() => 
{
    var pool = Databricks.GetInstancePool.Invoke(new()
    {
        Name = "All spot",
    });

    var myCluster = new Databricks.Cluster("my_cluster", new()
    {
        InstancePoolId = pool.Apply(getInstancePoolResult => getInstancePoolResult.Id),
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabricksFunctions;
import com.pulumi.databricks.inputs.GetInstancePoolArgs;
import com.pulumi.databricks.Cluster;
import com.pulumi.databricks.ClusterArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var pool = DatabricksFunctions.getInstancePool(GetInstancePoolArgs.builder()
            .name("All spot")
            .build());

        var myCluster = new Cluster("myCluster", ClusterArgs.builder()
            .instancePoolId(pool.id())
            .build());

    }
}

resources:
  myCluster:
    type: databricks:Cluster
    name: my_cluster
    properties:
      instancePoolId: ${pool.id}
variables:
  pool:
    fn::invoke:
      function: databricks:getInstancePool
      arguments:
        name: All spot

Example coming soon!

Using getInstancePool

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInstancePool(args: GetInstancePoolArgs, opts?: InvokeOptions): Promise<GetInstancePoolResult>
function getInstancePoolOutput(args: GetInstancePoolOutputArgs, opts?: InvokeOptions): Output<GetInstancePoolResult>

def get_instance_pool(name: Optional[str] = None,
                      pool_info: Optional[GetInstancePoolPoolInfo] = None,
                      provider_config: Optional[GetInstancePoolProviderConfig] = None,
                      opts: Optional[InvokeOptions] = None) -> GetInstancePoolResult
def get_instance_pool_output(name: pulumi.Input[Optional[str]] = None,
                      pool_info: pulumi.Input[Optional[GetInstancePoolPoolInfoArgs]] = None,
                      provider_config: pulumi.Input[Optional[GetInstancePoolProviderConfigArgs]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetInstancePoolResult]

func LookupInstancePool(ctx *Context, args *LookupInstancePoolArgs, opts ...InvokeOption) (*LookupInstancePoolResult, error)
func LookupInstancePoolOutput(ctx *Context, args *LookupInstancePoolOutputArgs, opts ...InvokeOption) LookupInstancePoolResultOutput

> Note: This function is named LookupInstancePool in the Go SDK.

public static class GetInstancePool 
{
    public static Task<GetInstancePoolResult> InvokeAsync(GetInstancePoolArgs args, InvokeOptions? opts = null)
    public static Output<GetInstancePoolResult> Invoke(GetInstancePoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInstancePoolResult> getInstancePool(GetInstancePoolArgs args, InvokeOptions options)
public static Output<GetInstancePoolResult> getInstancePool(GetInstancePoolArgs args, InvokeOptions options)

fn::invoke:
  function: databricks:index/getInstancePool:getInstancePool
  arguments:
    # arguments dictionary

data "databricks_getinstancepool" "name" {
    # arguments
}

The following arguments are supported:

Name string: Name of the instance pool. The instance pool must exist before this resource can be planned.
PoolInfo GetInstancePoolPoolInfo: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
ProviderConfig GetInstancePoolProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:

Name string: Name of the instance pool. The instance pool must exist before this resource can be planned.
PoolInfo GetInstancePoolPoolInfo: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
ProviderConfig GetInstancePoolProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:

name string: Name of the instance pool. The instance pool must exist before this resource can be planned.
pool_info object: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
provider_config object: Configure the provider for management through account provider. This block consists of the following fields:

name String: Name of the instance pool. The instance pool must exist before this resource can be planned.
poolInfo GetInstancePoolPoolInfo: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
providerConfig GetInstancePoolProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:

name string: Name of the instance pool. The instance pool must exist before this resource can be planned.
poolInfo GetInstancePoolPoolInfo: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
providerConfig GetInstancePoolProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:

name str: Name of the instance pool. The instance pool must exist before this resource can be planned.
pool_info GetInstancePoolPoolInfo: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
provider_config GetInstancePoolProviderConfig: Configure the provider for management through account provider. This block consists of the following fields:

name String: Name of the instance pool. The instance pool must exist before this resource can be planned.
poolInfo Property Map: block describing instance pool and its state. Check documentation for databricks.InstancePool for a list of exposed attributes.
providerConfig Property Map: Configure the provider for management through account provider. This block consists of the following fields: