1. Packages
  2. Databricks Provider
  3. API Docs
  4. getDatabaseInstance
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

databricks.getDatabaseInstance

databricks logo
Databricks v1.83.0 published on Friday, Jan 23, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-databricks

    Public Preview

    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(name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDatabaseInstanceResult
def get_database_instance_output(name: Optional[pulumi.Input[str]] = 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
    Name string
    The name of the instance. This is the unique identifier for the instance
    name String
    The name of the instance. This is the unique identifier for the instance
    name string
    The name of the instance. This is the unique identifier for the instance
    name str
    The name of the instance. This is the unique identifier for the instance
    name String
    The name of the instance. This is the unique identifier for the instance

    getDatabaseInstance Result

    The following output properties are available:

    Capacity string
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    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
    CustomTags List<GetDatabaseInstanceCustomTag>
    (list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses
    EffectiveCapacity string
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveCustomTags List<GetDatabaseInstanceEffectiveCustomTag>
    (list of CustomTag) - The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveEnablePgNativeLogin bool
    (boolean) - Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveEnableReadableSecondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveNodeCount 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveRetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveStopped bool
    (boolean) - Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveUsagePolicyId string
    (string) - The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EnablePgNativeLogin bool
    (boolean) - Whether to enable PG native password login on the instance. Defaults to false
    EnableReadableSecondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Name of the ref database instance
    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. This field is input only, see effective_node_count for the output
    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
    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
    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
    State string
    (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    Stopped bool
    (boolean) - Whether to stop the instance. An input only param, see effective_stopped for the output
    Uid string
    (string) - Id of the ref database instance
    UsagePolicyId string
    (string) - The desired usage policy to associate with the instance
    Capacity string
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    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
    CustomTags []GetDatabaseInstanceCustomTag
    (list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses
    EffectiveCapacity string
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveCustomTags []GetDatabaseInstanceEffectiveCustomTag
    (list of CustomTag) - The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveEnablePgNativeLogin bool
    (boolean) - Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveEnableReadableSecondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveNodeCount 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveRetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveStopped bool
    (boolean) - Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EffectiveUsagePolicyId string
    (string) - The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    EnablePgNativeLogin bool
    (boolean) - Whether to enable PG native password login on the instance. Defaults to false
    EnableReadableSecondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - Name of the ref database instance
    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. This field is input only, see effective_node_count for the output
    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
    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
    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
    State string
    (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    Stopped bool
    (boolean) - Whether to stop the instance. An input only param, see effective_stopped for the output
    Uid string
    (string) - Id of the ref database instance
    UsagePolicyId string
    (string) - The desired usage policy to associate with the instance
    capacity String
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    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
    customTags List<GetDatabaseInstanceCustomTag>
    (list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses
    effectiveCapacity String
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveCustomTags List<GetDatabaseInstanceEffectiveCustomTag>
    (list of CustomTag) - The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveEnablePgNativeLogin Boolean
    (boolean) - Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveEnableReadableSecondaries Boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveNodeCount 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveRetentionWindowInDays Integer
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveStopped Boolean
    (boolean) - Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveUsagePolicyId String
    (string) - The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    enablePgNativeLogin Boolean
    (boolean) - Whether to enable PG native password login on the instance. Defaults to false
    enableReadableSecondaries Boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Name of the ref database instance
    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. This field is input only, see effective_node_count for the output
    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
    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
    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
    state String
    (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    stopped Boolean
    (boolean) - Whether to stop the instance. An input only param, see effective_stopped for the output
    uid String
    (string) - Id of the ref database instance
    usagePolicyId String
    (string) - The desired usage policy to associate with the instance
    capacity string
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    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
    customTags GetDatabaseInstanceCustomTag[]
    (list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses
    effectiveCapacity string
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveCustomTags GetDatabaseInstanceEffectiveCustomTag[]
    (list of CustomTag) - The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveEnablePgNativeLogin boolean
    (boolean) - Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveEnableReadableSecondaries boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveNodeCount 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveRetentionWindowInDays number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveStopped boolean
    (boolean) - Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveUsagePolicyId string
    (string) - The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    enablePgNativeLogin boolean
    (boolean) - Whether to enable PG native password login on the instance. Defaults to false
    enableReadableSecondaries boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - Name of the ref database instance
    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. This field is input only, see effective_node_count for the output
    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
    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
    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
    state string
    (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    stopped boolean
    (boolean) - Whether to stop the instance. An input only param, see effective_stopped for the output
    uid string
    (string) - Id of the ref database instance
    usagePolicyId string
    (string) - The desired usage policy to associate with the instance
    capacity str
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    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
    custom_tags Sequence[GetDatabaseInstanceCustomTag]
    (list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses
    effective_capacity str
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_custom_tags Sequence[GetDatabaseInstanceEffectiveCustomTag]
    (list of CustomTag) - The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_enable_pg_native_login bool
    (boolean) - Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_enable_readable_secondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_stopped bool
    (boolean) - Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effective_usage_policy_id str
    (string) - The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    enable_pg_native_login bool
    (boolean) - Whether to enable PG native password login on the instance. Defaults to false
    enable_readable_secondaries bool
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - Name of the ref database instance
    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. This field is input only, see effective_node_count for the output
    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
    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
    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
    state str
    (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    stopped bool
    (boolean) - Whether to stop the instance. An input only param, see effective_stopped for the output
    uid str
    (string) - Id of the ref database instance
    usage_policy_id str
    (string) - The desired usage policy to associate with the instance
    capacity String
    (string) - The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    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
    customTags List<Property Map>
    (list of CustomTag) - Custom tags associated with the instance. This field is only included on create and update responses
    effectiveCapacity String
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveCustomTags List<Property Map>
    (list of CustomTag) - The recorded custom tags associated with the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveEnablePgNativeLogin Boolean
    (boolean) - Whether the instance has PG native password login enabled. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveEnableReadableSecondaries Boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveNodeCount 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveRetentionWindowInDays Number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveStopped Boolean
    (boolean) - Whether the instance is stopped. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    effectiveUsagePolicyId String
    (string) - The policy that is applied to the instance. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    enablePgNativeLogin Boolean
    (boolean) - Whether to enable PG native password login on the instance. Defaults to false
    enableReadableSecondaries Boolean
    (boolean) - Whether to enable secondaries to serve read-only traffic. Defaults to false
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - Name of the ref database instance
    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. This field is input only, see effective_node_count for the output
    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
    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
    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
    state String
    (string) - The current state of the instance. Possible values are: AVAILABLE, DELETING, FAILING_OVER, STARTING, STOPPED, UPDATING
    stopped Boolean
    (boolean) - Whether to stop the instance. An input only param, see effective_stopped for the output
    uid String
    (string) - Id of the ref database instance
    usagePolicyId String
    (string) - The desired usage policy to associate with the instance

    Supporting Types

    GetDatabaseInstanceChildInstanceRef

    EffectiveLsn string
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    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
    Name string
    The name of the instance. This is the unique identifier for the instance
    EffectiveLsn string
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    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
    Name string
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name String
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn string
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name string
    The name of the instance. This is the unique identifier for the instance
    effective_lsn str
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn str
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name str
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name String
    The name of the instance. This is the unique identifier for the instance

    GetDatabaseInstanceCustomTag

    Key string
    (string) - The key of the custom tag
    Value string
    (string) - The value of the custom tag
    Key string
    (string) - The key of the custom tag
    Value string
    (string) - The value of the custom tag
    key String
    (string) - The key of the custom tag
    value String
    (string) - The value of the custom tag
    key string
    (string) - The key of the custom tag
    value string
    (string) - The value of the custom tag
    key str
    (string) - The key of the custom tag
    value str
    (string) - The value of the custom tag
    key String
    (string) - The key of the custom tag
    value String
    (string) - The value of the custom tag

    GetDatabaseInstanceEffectiveCustomTag

    Key string
    (string) - The key of the custom tag
    Value string
    (string) - The value of the custom tag
    Key string
    (string) - The key of the custom tag
    Value string
    (string) - The value of the custom tag
    key String
    (string) - The key of the custom tag
    value String
    (string) - The value of the custom tag
    key string
    (string) - The key of the custom tag
    value string
    (string) - The value of the custom tag
    key str
    (string) - The key of the custom tag
    value str
    (string) - The value of the custom tag
    key String
    (string) - The key of the custom tag
    value String
    (string) - The value of the custom tag

    GetDatabaseInstanceParentInstanceRef

    EffectiveLsn string
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    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
    Name string
    The name of the instance. This is the unique identifier for the instance
    EffectiveLsn string
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    Lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    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
    Name string
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name String
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn string
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn string
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name string
    The name of the instance. This is the unique identifier for the instance
    effective_lsn str
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn str
    (string) - User-specified WAL LSN of the ref database instance.
    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
    name str
    The name of the instance. This is the unique identifier for the instance
    effectiveLsn String
    (string) - 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. This is an output only field that contains the value computed from the input field combined with server side defaults. Use the field without the effective_ prefix to set the value
    lsn String
    (string) - User-specified WAL LSN of the ref database instance.
    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
    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.83.0 published on Friday, Jan 23, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate