databricks.getDatabaseInstance

Explore with Pulumi AI

Databricks v1.73.0 published on Monday, Jul 14, 2025 by Pulumi

pulumi/pulumi-databricks

Example Usage

Referring to a Database Instance by name:

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

const _this = databricks.getDatabaseInstance({
    name: "my-database-instance",
});

import pulumi
import pulumi_databricks as databricks

this = databricks.get_database_instance(name="my-database-instance")

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.LookupDatabaseInstance(ctx, &databricks.LookupDatabaseInstanceArgs{
			Name: "my-database-instance",
		}, nil)
		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 @this = Databricks.GetDatabaseInstance.Invoke(new()
    {
        Name = "my-database-instance",
    });

});

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.GetDatabaseInstanceArgs;
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 this = DatabricksFunctions.getDatabaseInstance(GetDatabaseInstanceArgs.builder()
            .name("my-database-instance")
            .build());

    }
}

variables:
  this:
    fn::invoke:
      function: databricks:getDatabaseInstance
      arguments:
        name: my-database-instance

Using getDatabaseInstance

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 getDatabaseInstance(args: GetDatabaseInstanceArgs, opts?: InvokeOptions): Promise<GetDatabaseInstanceResult>
function getDatabaseInstanceOutput(args: GetDatabaseInstanceOutputArgs, opts?: InvokeOptions): Output<GetDatabaseInstanceResult>

def get_database_instance(capacity: Optional[str] = None,
                          name: Optional[str] = None,
                          stopped: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(capacity: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          stopped: Optional[pulumi.Input[bool]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseInstanceResult]

func LookupDatabaseInstance(ctx *Context, args *LookupDatabaseInstanceArgs, opts ...InvokeOption) (*LookupDatabaseInstanceResult, error)
func LookupDatabaseInstanceOutput(ctx *Context, args *LookupDatabaseInstanceOutputArgs, opts ...InvokeOption) LookupDatabaseInstanceResultOutput

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

public static class GetDatabaseInstance 
{
    public static Task<GetDatabaseInstanceResult> InvokeAsync(GetDatabaseInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseInstanceResult> Invoke(GetDatabaseInstanceInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)
public static Output<GetDatabaseInstanceResult> getDatabaseInstance(GetDatabaseInstanceArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: The name of the instance. This is the unique identifier for the instance
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
Stopped bool: (boolean) - Whether the instance is stopped

Name string: The name of the instance. This is the unique identifier for the instance
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
Stopped bool: (boolean) - Whether the instance is stopped

name String: The name of the instance. This is the unique identifier for the instance
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped Boolean: (boolean) - Whether the instance is stopped

name string: The name of the instance. This is the unique identifier for the instance
capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped boolean: (boolean) - Whether the instance is stopped

name str: The name of the instance. This is the unique identifier for the instance
capacity str: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped bool: (boolean) - Whether the instance is stopped

name String: The name of the instance. This is the unique identifier for the instance
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped Boolean: (boolean) - Whether the instance is stopped

getDatabaseInstance Result

The following output properties are available:

CreationTime string: (string) - The timestamp when the instance was created
Creator string: (string) - The email of the creator of the instance
EffectiveStopped bool: (boolean) - xref AIP-129. stopped is owned by the client, while effective_stopped is owned by the server. stopped will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_stopped on the other hand will always bet set in all response messages (Create/Update/Get/List)
Id string: The provider-assigned unique ID for this managed resource.
Name string: (string) - The name of the instance. This is the unique identifier for the instance
PgVersion string: (string) - The version of Postgres running on the instance
ReadWriteDns string: (string) - The DNS endpoint to connect to the instance for read+write access
State string: (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
Uid string: (string) - An immutable UUID identifier for the instance
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
Stopped bool: (boolean) - Whether the instance is stopped

CreationTime string: (string) - The timestamp when the instance was created
Creator string: (string) - The email of the creator of the instance
EffectiveStopped bool: (boolean) - xref AIP-129. stopped is owned by the client, while effective_stopped is owned by the server. stopped will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_stopped on the other hand will always bet set in all response messages (Create/Update/Get/List)
Id string: The provider-assigned unique ID for this managed resource.
Name string: (string) - The name of the instance. This is the unique identifier for the instance
PgVersion string: (string) - The version of Postgres running on the instance
ReadWriteDns string: (string) - The DNS endpoint to connect to the instance for read+write access
State string: (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
Uid string: (string) - An immutable UUID identifier for the instance
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
Stopped bool: (boolean) - Whether the instance is stopped

creationTime String: (string) - The timestamp when the instance was created
creator String: (string) - The email of the creator of the instance
effectiveStopped Boolean: (boolean) - xref AIP-129. stopped is owned by the client, while effective_stopped is owned by the server. stopped will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_stopped on the other hand will always bet set in all response messages (Create/Update/Get/List)
id String: The provider-assigned unique ID for this managed resource.
name String: (string) - The name of the instance. This is the unique identifier for the instance
pgVersion String: (string) - The version of Postgres running on the instance
readWriteDns String: (string) - The DNS endpoint to connect to the instance for read+write access
state String: (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
uid String: (string) - An immutable UUID identifier for the instance
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped Boolean: (boolean) - Whether the instance is stopped

creationTime string: (string) - The timestamp when the instance was created
creator string: (string) - The email of the creator of the instance
effectiveStopped boolean: (boolean) - xref AIP-129. stopped is owned by the client, while effective_stopped is owned by the server. stopped will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_stopped on the other hand will always bet set in all response messages (Create/Update/Get/List)
id string: The provider-assigned unique ID for this managed resource.
name string: (string) - The name of the instance. This is the unique identifier for the instance
pgVersion string: (string) - The version of Postgres running on the instance
readWriteDns string: (string) - The DNS endpoint to connect to the instance for read+write access
state string: (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
uid string: (string) - An immutable UUID identifier for the instance
capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped boolean: (boolean) - Whether the instance is stopped

creation_time str: (string) - The timestamp when the instance was created
creator str: (string) - The email of the creator of the instance
effective_stopped bool: (boolean) - xref AIP-129. stopped is owned by the client, while effective_stopped is owned by the server. stopped will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_stopped on the other hand will always bet set in all response messages (Create/Update/Get/List)
id str: The provider-assigned unique ID for this managed resource.
name str: (string) - The name of the instance. This is the unique identifier for the instance
pg_version str: (string) - The version of Postgres running on the instance
read_write_dns str: (string) - The DNS endpoint to connect to the instance for read+write access
state str: (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
uid str: (string) - An immutable UUID identifier for the instance
capacity str: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped bool: (boolean) - Whether the instance is stopped

creationTime String: (string) - The timestamp when the instance was created
creator String: (string) - The email of the creator of the instance
effectiveStopped Boolean: (boolean) - xref AIP-129. stopped is owned by the client, while effective_stopped is owned by the server. stopped will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_stopped on the other hand will always bet set in all response messages (Create/Update/Get/List)
id String: The provider-assigned unique ID for this managed resource.
name String: (string) - The name of the instance. This is the unique identifier for the instance
pgVersion String: (string) - The version of Postgres running on the instance
readWriteDns String: (string) - The DNS endpoint to connect to the instance for read+write access
state String: (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
uid String: (string) - An immutable UUID identifier for the instance
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
stopped Boolean: (boolean) - Whether the instance is stopped

Package Details

Repository: databricks pulumi/pulumi-databricks
License: Apache-2.0
Notes: This Pulumi package is based on the databricks Terraform Provider.

Databricks v1.73.0 published on Monday, Jul 14, 2025 by Pulumi

pulumi/pulumi-databricks

databricks.getDatabaseInstance

On this page

On this page

Example Usage

Using getDatabaseInstance

getDatabaseInstance Result

Package Details

On this page

On this page