1. Pulumi Registry
  2. Databricks
  3. API Docs
  4. getClusters
databricks logo
Databricks v1.10.0, Mar 15 23

databricks.getClusters

The following resources are used in the same context:

  • End to end workspace management guide.
  • databricks.Cluster to create Databricks Clusters.
  • databricks.ClusterPolicy to create a databricks.Cluster policy, which limits the ability to create clusters based on a set of rules.
  • databricks.InstancePool to manage instance pools to reduce cluster start and auto-scaling times by maintaining a set of idle, ready-to-use instances.
  • databricks.Job to manage Databricks Jobs to run non-interactive code in a databricks_cluster.
  • databricks.Library to install a library on databricks_cluster.
  • databricks.Pipeline to deploy Delta Live Tables.

Example Usage

Retrieve all clusters on this workspace on AWS or GCP

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

return await Deployment.RunAsync(() => 
{
    var all = Databricks.GetClusters.Invoke();

});

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 {
		_, err := databricks.GetClusters(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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.GetClustersArgs;
import java.util.List;
import java.util.ArrayList;
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 all = DatabricksFunctions.getClusters();

    }
}

import pulumi
import pulumi_databricks as databricks

all = databricks.get_clusters()

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

const all = databricks.getClusters({});

variables:
  all:
    fn::invoke:
      Function: databricks:getClusters
      Arguments: {}

Retrieve all clusters with "Shared" in their cluster name on this Azure Databricks workspace

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

return await Deployment.RunAsync(() => 
{
    var allShared = Databricks.GetClusters.Invoke(new()
    {
        ClusterNameContains = "shared",
    });

});

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 {
		_, err := databricks.GetClusters(ctx, &databricks.GetClustersArgs{
			ClusterNameContains: pulumi.StringRef("shared"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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.GetClustersArgs;
import java.util.List;
import java.util.ArrayList;
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 allShared = DatabricksFunctions.getClusters(GetClustersArgs.builder()
            .clusterNameContains("shared")
            .build());

    }
}

import pulumi
import pulumi_databricks as databricks

all_shared = databricks.get_clusters(cluster_name_contains="shared")

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

const allShared = databricks.getClusters({
    clusterNameContains: "shared",
});

variables:
  allShared:
    fn::invoke:
      Function: databricks:getClusters
      Arguments:
        clusterNameContains: shared

Using getClusters

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 getClusters(args: GetClustersArgs, opts?: InvokeOptions): Promise<GetClustersResult>
function getClustersOutput(args: GetClustersOutputArgs, opts?: InvokeOptions): Output<GetClustersResult>
def get_clusters(cluster_name_contains: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetClustersResult
def get_clusters_output(cluster_name_contains: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetClustersResult]
func GetClusters(ctx *Context, args *GetClustersArgs, opts ...InvokeOption) (*GetClustersResult, error)
func GetClustersOutput(ctx *Context, args *GetClustersOutputArgs, opts ...InvokeOption) GetClustersResultOutput

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

public static class GetClusters 
{
    public static Task<GetClustersResult> InvokeAsync(GetClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetClustersResult> Invoke(GetClustersInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetClustersResult> getClusters(GetClustersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

ClusterNameContains string

Only return databricks.Cluster ids that match the given name string.

ClusterNameContains string

Only return databricks.Cluster ids that match the given name string.

clusterNameContains String

Only return databricks.Cluster ids that match the given name string.

clusterNameContains string

Only return databricks.Cluster ids that match the given name string.

cluster_name_contains str

Only return databricks.Cluster ids that match the given name string.

clusterNameContains String

Only return databricks.Cluster ids that match the given name string.

getClusters Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

list of databricks.Cluster ids

ClusterNameContains string
Id string

The provider-assigned unique ID for this managed resource.

Ids []string

list of databricks.Cluster ids

ClusterNameContains string
id String

The provider-assigned unique ID for this managed resource.

ids List<String>

list of databricks.Cluster ids

clusterNameContains String
id string

The provider-assigned unique ID for this managed resource.

ids string[]

list of databricks.Cluster ids

clusterNameContains string
id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]

list of databricks.Cluster ids

cluster_name_contains str
id String

The provider-assigned unique ID for this managed resource.

ids List<String>

list of databricks.Cluster ids

clusterNameContains String

Package Details

Repository
databricks pulumi/pulumi-databricks
License
Apache-2.0
Notes

This Pulumi package is based on the databricks Terraform Provider.