databricks.getDatabaseInstance

Explore with Pulumi AI

Databricks v1.71.0 published on Monday, Jun 9, 2025 by Pulumi

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(admin_password: Optional[str] = None,
                          admin_rolename: Optional[str] = None,
                          capacity: Optional[str] = None,
                          name: Optional[str] = None,
                          stopped: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(admin_password: Optional[pulumi.Input[str]] = None,
                          admin_rolename: Optional[pulumi.Input[str]] = None,
                          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
AdminPassword string: (string) - Password for admin user to create. If not provided, no user will be created
AdminRolename string: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
Stopped bool: (boolean) - Whether the instance is stopped

Name string: The name of the instance. This is the unique identifier for the instance
AdminPassword string: (string) - Password for admin user to create. If not provided, no user will be created
AdminRolename string: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
Stopped bool: (boolean) - Whether the instance is stopped

name String: The name of the instance. This is the unique identifier for the instance
adminPassword String: (string) - Password for admin user to create. If not provided, no user will be created
adminRolename String: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
stopped Boolean: (boolean) - Whether the instance is stopped

name string: The name of the instance. This is the unique identifier for the instance
adminPassword string: (string) - Password for admin user to create. If not provided, no user will be created
adminRolename string: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
stopped boolean: (boolean) - Whether the instance is stopped

name str: The name of the instance. This is the unique identifier for the instance
admin_password str: (string) - Password for admin user to create. If not provided, no user will be created
admin_rolename str: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity str: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
stopped bool: (boolean) - Whether the instance is stopped

name String: The name of the instance. This is the unique identifier for the instance
adminPassword String: (string) - Password for admin user to create. If not provided, no user will be created
adminRolename String: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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
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
AdminPassword string: (string) - Password for admin user to create. If not provided, no user will be created
AdminRolename string: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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
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
AdminPassword string: (string) - Password for admin user to create. If not provided, no user will be created
AdminRolename string: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
Capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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
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
adminPassword String: (string) - Password for admin user to create. If not provided, no user will be created
adminRolename String: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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
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
adminPassword string: (string) - Password for admin user to create. If not provided, no user will be created
adminRolename string: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity string: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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
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
admin_password str: (string) - Password for admin user to create. If not provided, no user will be created
admin_rolename str: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity str: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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
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
adminPassword String: (string) - Password for admin user to create. If not provided, no user will be created
adminRolename String: (string) - Name of the admin role for the instance. If not provided, defaults to 'databricks_admin'
capacity String: (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4"
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.71.0 published on Monday, Jun 9, 2025 by Pulumi

pulumi/pulumi-databricks

databricks.getDatabaseInstance

On this page

On this page

Using getDatabaseInstance

getDatabaseInstance Result

Package Details

On this page

On this page