Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Databricks Provider
  3. API Docs
  4. getDatabaseInstance
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.getDatabaseInstance

Explore with Pulumi AI

databricks logo
Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
pulumi/pulumi-databricks

    This data source can be used to get a single Database Instance.

    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,
                          enable_readable_secondaries: Optional[bool] = None,
                          name: Optional[str] = None,
                          node_count: Optional[int] = None,
                          parent_instance_ref: Optional[GetDatabaseInstanceParentInstanceRef] = None,
                          retention_window_in_days: Optional[int] = None,
                          stopped: Optional[bool] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(capacity: Optional[pulumi.Input[str]] = None,
                          enable_readable_secondaries: Optional[pulumi.Input[bool]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          node_count: Optional[pulumi.Input[int]] = None,
                          parent_instance_ref: Optional[pulumi.Input[GetDatabaseInstanceParentInstanceRefArgs]] = None,
                          retention_window_in_days: Optional[pulumi.Input[int]] = 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"
    EnableReadableSecondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    NodeCount int
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    RetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    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"
    EnableReadableSecondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    NodeCount int
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    RetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    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"
    enableReadableSecondaries Boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    nodeCount Integer
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retentionWindowInDays Integer
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    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"
    enableReadableSecondaries boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    nodeCount number
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retentionWindowInDays number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    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"
    enable_readable_secondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    node_count int
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parent_instance_ref GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retention_window_in_days int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    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"
    enableReadableSecondaries Boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    nodeCount Number
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef Property Map
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retentionWindowInDays Number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    stopped Boolean
    (boolean) - Whether the instance is stopped

    getDatabaseInstance Result

    The following output properties are available:

    ChildInstanceRefs List<GetDatabaseInstanceChildInstanceRef>
    (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is parent instance
    CreationTime string
    (string) - The timestamp when the instance was created
    Creator string
    (string) - The email of the creator of the instance
    EffectiveEnableReadableSecondaries bool
    (boolean) - xref AIP-129. enable_readable_secondaries is owned by the client, while effective_enable_readable_secondaries is owned by the server. enable_readable_secondaries will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_enable_readable_secondaries on the other hand will always bet set in all response messages (Create/Update/Get/List)
    EffectiveNodeCount int
    (integer) - xref AIP-129. node_count is owned by the client, while effective_node_count is owned by the server. node_count will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_node_count on the other hand will always bet set in all response messages (Create/Update/Get/List)
    EffectiveRetentionWindowInDays int
    (integer) - xref AIP-129. retention_window_in_days is owned by the client, while effective_retention_window_in_days is owned by the server. retention_window_in_days will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_retention_window_in_days on the other hand will always bet set in all response messages (Create/Update/Get/List)
    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) - Name of the ref database instance
    PgVersion string
    (string) - The version of Postgres running on the instance
    ReadOnlyDns string
    (string) - The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true
    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) - Id of the ref database instance
    Capacity string
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    EnableReadableSecondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    NodeCount int
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    RetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    Stopped bool
    (boolean) - Whether the instance is stopped
    ChildInstanceRefs []GetDatabaseInstanceChildInstanceRef
    (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is parent instance
    CreationTime string
    (string) - The timestamp when the instance was created
    Creator string
    (string) - The email of the creator of the instance
    EffectiveEnableReadableSecondaries bool
    (boolean) - xref AIP-129. enable_readable_secondaries is owned by the client, while effective_enable_readable_secondaries is owned by the server. enable_readable_secondaries will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_enable_readable_secondaries on the other hand will always bet set in all response messages (Create/Update/Get/List)
    EffectiveNodeCount int
    (integer) - xref AIP-129. node_count is owned by the client, while effective_node_count is owned by the server. node_count will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_node_count on the other hand will always bet set in all response messages (Create/Update/Get/List)
    EffectiveRetentionWindowInDays int
    (integer) - xref AIP-129. retention_window_in_days is owned by the client, while effective_retention_window_in_days is owned by the server. retention_window_in_days will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_retention_window_in_days on the other hand will always bet set in all response messages (Create/Update/Get/List)
    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) - Name of the ref database instance
    PgVersion string
    (string) - The version of Postgres running on the instance
    ReadOnlyDns string
    (string) - The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true
    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) - Id of the ref database instance
    Capacity string
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    EnableReadableSecondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    NodeCount int
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    RetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    Stopped bool
    (boolean) - Whether the instance is stopped
    childInstanceRefs List<GetDatabaseInstanceChildInstanceRef>
    (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is parent instance
    creationTime String
    (string) - The timestamp when the instance was created
    creator String
    (string) - The email of the creator of the instance
    effectiveEnableReadableSecondaries Boolean
    (boolean) - xref AIP-129. enable_readable_secondaries is owned by the client, while effective_enable_readable_secondaries is owned by the server. enable_readable_secondaries will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_enable_readable_secondaries on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effectiveNodeCount Integer
    (integer) - xref AIP-129. node_count is owned by the client, while effective_node_count is owned by the server. node_count will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_node_count on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effectiveRetentionWindowInDays Integer
    (integer) - xref AIP-129. retention_window_in_days is owned by the client, while effective_retention_window_in_days is owned by the server. retention_window_in_days will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_retention_window_in_days on the other hand will always bet set in all response messages (Create/Update/Get/List)
    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) - Name of the ref database instance
    pgVersion String
    (string) - The version of Postgres running on the instance
    readOnlyDns String
    (string) - The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true
    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) - Id of the ref database instance
    capacity String
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enableReadableSecondaries Boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    nodeCount Integer
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retentionWindowInDays Integer
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    stopped Boolean
    (boolean) - Whether the instance is stopped
    childInstanceRefs GetDatabaseInstanceChildInstanceRef[]
    (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is parent instance
    creationTime string
    (string) - The timestamp when the instance was created
    creator string
    (string) - The email of the creator of the instance
    effectiveEnableReadableSecondaries boolean
    (boolean) - xref AIP-129. enable_readable_secondaries is owned by the client, while effective_enable_readable_secondaries is owned by the server. enable_readable_secondaries will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_enable_readable_secondaries on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effectiveNodeCount number
    (integer) - xref AIP-129. node_count is owned by the client, while effective_node_count is owned by the server. node_count will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_node_count on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effectiveRetentionWindowInDays number
    (integer) - xref AIP-129. retention_window_in_days is owned by the client, while effective_retention_window_in_days is owned by the server. retention_window_in_days will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_retention_window_in_days on the other hand will always bet set in all response messages (Create/Update/Get/List)
    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) - Name of the ref database instance
    pgVersion string
    (string) - The version of Postgres running on the instance
    readOnlyDns string
    (string) - The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true
    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) - Id of the ref database instance
    capacity string
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enableReadableSecondaries boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    nodeCount number
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retentionWindowInDays number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    stopped boolean
    (boolean) - Whether the instance is stopped
    child_instance_refs Sequence[GetDatabaseInstanceChildInstanceRef]
    (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is parent instance
    creation_time str
    (string) - The timestamp when the instance was created
    creator str
    (string) - The email of the creator of the instance
    effective_enable_readable_secondaries bool
    (boolean) - xref AIP-129. enable_readable_secondaries is owned by the client, while effective_enable_readable_secondaries is owned by the server. enable_readable_secondaries will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_enable_readable_secondaries on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effective_node_count int
    (integer) - xref AIP-129. node_count is owned by the client, while effective_node_count is owned by the server. node_count will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_node_count on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effective_retention_window_in_days int
    (integer) - xref AIP-129. retention_window_in_days is owned by the client, while effective_retention_window_in_days is owned by the server. retention_window_in_days will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_retention_window_in_days on the other hand will always bet set in all response messages (Create/Update/Get/List)
    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) - Name of the ref database instance
    pg_version str
    (string) - The version of Postgres running on the instance
    read_only_dns str
    (string) - The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true
    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) - Id of the ref database instance
    capacity str
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enable_readable_secondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    node_count int
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parent_instance_ref GetDatabaseInstanceParentInstanceRef
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retention_window_in_days int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    stopped bool
    (boolean) - Whether the instance is stopped
    childInstanceRefs List<Property Map>
    (list of DatabaseInstanceRef) - The refs of the child instances. This is only available if the instance is parent instance
    creationTime String
    (string) - The timestamp when the instance was created
    creator String
    (string) - The email of the creator of the instance
    effectiveEnableReadableSecondaries Boolean
    (boolean) - xref AIP-129. enable_readable_secondaries is owned by the client, while effective_enable_readable_secondaries is owned by the server. enable_readable_secondaries will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_enable_readable_secondaries on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effectiveNodeCount Number
    (integer) - xref AIP-129. node_count is owned by the client, while effective_node_count is owned by the server. node_count will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_node_count on the other hand will always bet set in all response messages (Create/Update/Get/List)
    effectiveRetentionWindowInDays Number
    (integer) - xref AIP-129. retention_window_in_days is owned by the client, while effective_retention_window_in_days is owned by the server. retention_window_in_days will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_retention_window_in_days on the other hand will always bet set in all response messages (Create/Update/Get/List)
    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) - Name of the ref database instance
    pgVersion String
    (string) - The version of Postgres running on the instance
    readOnlyDns String
    (string) - The DNS endpoint to connect to the instance for read only access. This is only available if enable_readable_secondaries is true
    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) - Id of the ref database instance
    capacity String
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enableReadableSecondaries Boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    nodeCount Number
    (integer) - The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef Property Map
    (DatabaseInstanceRef) - The ref of the parent instance. This is only available if the instance is child instance. Input: For specifying the parent instance to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    retentionWindowInDays Number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. The default value is 7 days. Valid values are 2 to 35 days
    stopped Boolean
    (boolean) - Whether the instance is stopped

    Supporting Types

    GetDatabaseInstanceChildInstanceRef

    EffectiveLsn string
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    Uid string
    (string) - Id of the ref database instance
    BranchTime string
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    Name string
    The name of the instance. This is the unique identifier for the instance
    EffectiveLsn string
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    Uid string
    (string) - Id of the ref database instance
    BranchTime string
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    Name string
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid String
    (string) - Id of the ref database instance
    branchTime String
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    name String
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn string
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid string
    (string) - Id of the ref database instance
    branchTime string
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    name string
    The name of the instance. This is the unique identifier for the instance
    effective_lsn str
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid str
    (string) - Id of the ref database instance
    branch_time str
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn str
    (string) - User-specified WAL LSN of the ref database instance.
    name str
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid String
    (string) - Id of the ref database instance
    branchTime String
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    name String
    The name of the instance. This is the unique identifier for the instance

    GetDatabaseInstanceParentInstanceRef

    EffectiveLsn string
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    Uid string
    (string) - Id of the ref database instance
    BranchTime string
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    Name string
    The name of the instance. This is the unique identifier for the instance
    EffectiveLsn string
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    Uid string
    (string) - Id of the ref database instance
    BranchTime string
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    Name string
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid String
    (string) - Id of the ref database instance
    branchTime String
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    name String
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn string
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid string
    (string) - Id of the ref database instance
    branchTime string
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    name string
    The name of the instance. This is the unique identifier for the instance
    effective_lsn str
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid str
    (string) - Id of the ref database instance
    branch_time str
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn str
    (string) - User-specified WAL LSN of the ref database instance.
    name str
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - xref AIP-129. lsn is owned by the client, while effective_lsn is owned by the server. lsn will only be set in Create/Update response messages if and only if the user provides the field via the request. effective_lsn on the other hand will always bet set in all response messages (Create/Update/Get/List). For a parent ref instance, this is the LSN on the parent instance from which the instance was created. For a child ref instance, this is the LSN on the instance from which the child instance was created
    uid String
    (string) - Id of the ref database instance
    branchTime String
    (string) - Branch time of the ref database instance. For a parent ref instance, this is the point in time on the parent instance from which the instance was created. For a child ref instance, this is the point in time on the instance from which the child instance was created. Input: For specifying the point in time to create a child instance. Optional. Output: Only populated if provided as input to create a child instance
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    name String
    The name of the instance. This is the unique identifier for the instance

    Package Details

    Repository
    databricks pulumi/pulumi-databricks
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the databricks Terraform Provider.
    databricks logo
    Databricks v1.74.0 published on Thursday, Aug 14, 2025 by Pulumi
    pulumi/pulumi-databricks