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

databricks.DatabaseInstance

Explore with Pulumi AI

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

    Lakebase Database Instances are managed Postgres instances, composed of a primary Postgres compute instance and 0 or more read replica instances.

    Example Usage

    Basic Example

    This example creates a simple Database Instance with the specified name and capacity.

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

const _this = new databricks.DatabaseInstance("this", {
    name: "my-database-instance",
    capacity: "CU_2",
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.DatabaseInstance("this",
    name="my-database-instance",
    capacity="CU_2")

    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.NewDatabaseInstance(ctx, "this", &databricks.DatabaseInstanceArgs{
			Name:     pulumi.String("my-database-instance"),
			Capacity: pulumi.String("CU_2"),
		})
		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 = new Databricks.DatabaseInstance("this", new()
    {
        Name = "my-database-instance",
        Capacity = "CU_2",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabaseInstance;
import com.pulumi.databricks.DatabaseInstanceArgs;
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) {
        var this_ = new DatabaseInstance("this", DatabaseInstanceArgs.builder()
            .name("my-database-instance")
            .capacity("CU_2")
            .build());

    }
}

    resources:
  this:
    type: databricks:DatabaseInstance
    properties:
      name: my-database-instance
      capacity: CU_2

    Example with Readable Secondaries

    This example creates a Database Instance with readable secondaries (and HA) enabled.

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

const _this = new databricks.DatabaseInstance("this", {
    name: "my-database-instance",
    capacity: "CU_2",
    nodeCount: 2,
    enableReadableSecondaries: true,
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.DatabaseInstance("this",
    name="my-database-instance",
    capacity="CU_2",
    node_count=2,
    enable_readable_secondaries=True)

    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.NewDatabaseInstance(ctx, "this", &databricks.DatabaseInstanceArgs{
			Name:                      pulumi.String("my-database-instance"),
			Capacity:                  pulumi.String("CU_2"),
			NodeCount:                 pulumi.Int(2),
			EnableReadableSecondaries: pulumi.Bool(true),
		})
		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 = new Databricks.DatabaseInstance("this", new()
    {
        Name = "my-database-instance",
        Capacity = "CU_2",
        NodeCount = 2,
        EnableReadableSecondaries = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabaseInstance;
import com.pulumi.databricks.DatabaseInstanceArgs;
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) {
        var this_ = new DatabaseInstance("this", DatabaseInstanceArgs.builder()
            .name("my-database-instance")
            .capacity("CU_2")
            .nodeCount(2)
            .enableReadableSecondaries(true)
            .build());

    }
}

    resources:
  this:
    type: databricks:DatabaseInstance
    properties:
      name: my-database-instance
      capacity: CU_2
      nodeCount: 2
      enableReadableSecondaries: true

    Example Child Instance Created From Parent

    This example creates a child Database Instance from a specified parent Database Instance at the current point in time.

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

const child = new databricks.DatabaseInstance("child", {
    name: "my-database-instance",
    capacity: "CU_2",
    parentInstanceRef: {
        name: "my-parent-instance",
    },
});

    import pulumi
import pulumi_databricks as databricks

child = databricks.DatabaseInstance("child",
    name="my-database-instance",
    capacity="CU_2",
    parent_instance_ref={
        "name": "my-parent-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.NewDatabaseInstance(ctx, "child", &databricks.DatabaseInstanceArgs{
			Name:     pulumi.String("my-database-instance"),
			Capacity: pulumi.String("CU_2"),
			ParentInstanceRef: &databricks.DatabaseInstanceParentInstanceRefArgs{
				Name: pulumi.String("my-parent-instance"),
			},
		})
		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 child = new Databricks.DatabaseInstance("child", new()
    {
        Name = "my-database-instance",
        Capacity = "CU_2",
        ParentInstanceRef = new Databricks.Inputs.DatabaseInstanceParentInstanceRefArgs
        {
            Name = "my-parent-instance",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.databricks.DatabaseInstance;
import com.pulumi.databricks.DatabaseInstanceArgs;
import com.pulumi.databricks.inputs.DatabaseInstanceParentInstanceRefArgs;
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) {
        var child = new DatabaseInstance("child", DatabaseInstanceArgs.builder()
            .name("my-database-instance")
            .capacity("CU_2")
            .parentInstanceRef(DatabaseInstanceParentInstanceRefArgs.builder()
                .name("my-parent-instance")
                .build())
            .build());

    }
}

    resources:
  child:
    type: databricks:DatabaseInstance
    properties:
      name: my-database-instance
      capacity: CU_2
      parentInstanceRef:
        name: my-parent-instance

    Create DatabaseInstance Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DatabaseInstance(name: string, args?: DatabaseInstanceArgs, opts?: CustomResourceOptions);
    @overload
def DatabaseInstance(resource_name: str,
                     args: Optional[DatabaseInstanceArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def DatabaseInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     capacity: Optional[str] = None,
                     enable_readable_secondaries: Optional[bool] = None,
                     name: Optional[str] = None,
                     node_count: Optional[int] = None,
                     parent_instance_ref: Optional[DatabaseInstanceParentInstanceRefArgs] = None,
                     purge_on_delete: Optional[bool] = None,
                     retention_window_in_days: Optional[int] = None,
                     stopped: Optional[bool] = None)
    func NewDatabaseInstance(ctx *Context, name string, args *DatabaseInstanceArgs, opts ...ResourceOption) (*DatabaseInstance, error)
    public DatabaseInstance(string name, DatabaseInstanceArgs? args = null, CustomResourceOptions? opts = null)
    public DatabaseInstance(String name, DatabaseInstanceArgs args)
public DatabaseInstance(String name, DatabaseInstanceArgs args, CustomResourceOptions options)

    type: databricks:DatabaseInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseInstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var databaseInstanceResource = new Databricks.DatabaseInstance("databaseInstanceResource", new()
{
    Capacity = "string",
    EnableReadableSecondaries = false,
    Name = "string",
    NodeCount = 0,
    ParentInstanceRef = new Databricks.Inputs.DatabaseInstanceParentInstanceRefArgs
    {
        BranchTime = "string",
        EffectiveLsn = "string",
        Lsn = "string",
        Name = "string",
        Uid = "string",
    },
    PurgeOnDelete = false,
    RetentionWindowInDays = 0,
    Stopped = false,
});

    example, err := databricks.NewDatabaseInstance(ctx, "databaseInstanceResource", &databricks.DatabaseInstanceArgs{
	Capacity:                  pulumi.String("string"),
	EnableReadableSecondaries: pulumi.Bool(false),
	Name:                      pulumi.String("string"),
	NodeCount:                 pulumi.Int(0),
	ParentInstanceRef: &databricks.DatabaseInstanceParentInstanceRefArgs{
		BranchTime:   pulumi.String("string"),
		EffectiveLsn: pulumi.String("string"),
		Lsn:          pulumi.String("string"),
		Name:         pulumi.String("string"),
		Uid:          pulumi.String("string"),
	},
	PurgeOnDelete:         pulumi.Bool(false),
	RetentionWindowInDays: pulumi.Int(0),
	Stopped:               pulumi.Bool(false),
})

    var databaseInstanceResource = new DatabaseInstance("databaseInstanceResource", DatabaseInstanceArgs.builder()
    .capacity("string")
    .enableReadableSecondaries(false)
    .name("string")
    .nodeCount(0)
    .parentInstanceRef(DatabaseInstanceParentInstanceRefArgs.builder()
        .branchTime("string")
        .effectiveLsn("string")
        .lsn("string")
        .name("string")
        .uid("string")
        .build())
    .purgeOnDelete(false)
    .retentionWindowInDays(0)
    .stopped(false)
    .build());

    database_instance_resource = databricks.DatabaseInstance("databaseInstanceResource",
    capacity="string",
    enable_readable_secondaries=False,
    name="string",
    node_count=0,
    parent_instance_ref={
        "branch_time": "string",
        "effective_lsn": "string",
        "lsn": "string",
        "name": "string",
        "uid": "string",
    },
    purge_on_delete=False,
    retention_window_in_days=0,
    stopped=False)

    const databaseInstanceResource = new databricks.DatabaseInstance("databaseInstanceResource", {
    capacity: "string",
    enableReadableSecondaries: false,
    name: "string",
    nodeCount: 0,
    parentInstanceRef: {
        branchTime: "string",
        effectiveLsn: "string",
        lsn: "string",
        name: "string",
        uid: "string",
    },
    purgeOnDelete: false,
    retentionWindowInDays: 0,
    stopped: false,
});

    type: databricks:DatabaseInstance
properties:
    capacity: string
    enableReadableSecondaries: false
    name: string
    nodeCount: 0
    parentInstanceRef:
        branchTime: string
        effectiveLsn: string
        lsn: string
        name: string
        uid: string
    purgeOnDelete: false
    retentionWindowInDays: 0
    stopped: false

    DatabaseInstance Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DatabaseInstance resource accepts the following input properties:

    Capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    EnableReadableSecondaries bool
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    Name string
    The name of the instance. This is the unique identifier for the instance
    NodeCount int
    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef DatabaseInstanceParentInstanceRef
    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
    PurgeOnDelete bool
    Purge the resource on delete
    RetentionWindowInDays int
    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
    Whether the instance is stopped
    Capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    EnableReadableSecondaries bool
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    Name string
    The name of the instance. This is the unique identifier for the instance
    NodeCount int
    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef DatabaseInstanceParentInstanceRefArgs
    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
    PurgeOnDelete bool
    Purge the resource on delete
    RetentionWindowInDays int
    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
    Whether the instance is stopped
    capacity String
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enableReadableSecondaries Boolean
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name String
    The name of the instance. This is the unique identifier for the instance
    nodeCount 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 DatabaseInstanceParentInstanceRef
    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
    purgeOnDelete Boolean
    Purge the resource on delete
    retentionWindowInDays 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
    Whether the instance is stopped
    capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enableReadableSecondaries boolean
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name string
    The name of the instance. This is the unique identifier for the instance
    nodeCount number
    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef DatabaseInstanceParentInstanceRef
    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
    purgeOnDelete boolean
    Purge the resource on delete
    retentionWindowInDays number
    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
    Whether the instance is stopped
    capacity str
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enable_readable_secondaries bool
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name str
    The name of the instance. This is the unique identifier for the instance
    node_count int
    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 DatabaseInstanceParentInstanceRefArgs
    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
    purge_on_delete bool
    Purge the resource on delete
    retention_window_in_days int
    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
    Whether the instance is stopped
    capacity String
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    enableReadableSecondaries Boolean
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name String
    The name of the instance. This is the unique identifier for the instance
    nodeCount Number
    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
    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
    purgeOnDelete Boolean
    Purge the resource on delete
    retentionWindowInDays Number
    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
    Whether the instance is stopped

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DatabaseInstance resource produces the following output properties:

    ChildInstanceRefs List<DatabaseInstanceChildInstanceRef>
    (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.
    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
    ChildInstanceRefs []DatabaseInstanceChildInstanceRef
    (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.
    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
    childInstanceRefs List<DatabaseInstanceChildInstanceRef>
    (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.
    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
    childInstanceRefs DatabaseInstanceChildInstanceRef[]
    (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.
    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
    child_instance_refs Sequence[DatabaseInstanceChildInstanceRef]
    (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.
    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
    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.
    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

    Look up Existing DatabaseInstance Resource

    Get an existing DatabaseInstance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DatabaseInstanceState, opts?: CustomResourceOptions): DatabaseInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity: Optional[str] = None,
        child_instance_refs: Optional[Sequence[DatabaseInstanceChildInstanceRefArgs]] = None,
        creation_time: Optional[str] = None,
        creator: Optional[str] = None,
        effective_enable_readable_secondaries: Optional[bool] = None,
        effective_node_count: Optional[int] = None,
        effective_retention_window_in_days: Optional[int] = None,
        effective_stopped: Optional[bool] = None,
        enable_readable_secondaries: Optional[bool] = None,
        name: Optional[str] = None,
        node_count: Optional[int] = None,
        parent_instance_ref: Optional[DatabaseInstanceParentInstanceRefArgs] = None,
        pg_version: Optional[str] = None,
        purge_on_delete: Optional[bool] = None,
        read_only_dns: Optional[str] = None,
        read_write_dns: Optional[str] = None,
        retention_window_in_days: Optional[int] = None,
        state: Optional[str] = None,
        stopped: Optional[bool] = None,
        uid: Optional[str] = None) -> DatabaseInstance
    func GetDatabaseInstance(ctx *Context, name string, id IDInput, state *DatabaseInstanceState, opts ...ResourceOption) (*DatabaseInstance, error)
    public static DatabaseInstance Get(string name, Input<string> id, DatabaseInstanceState? state, CustomResourceOptions? opts = null)
    public static DatabaseInstance get(String name, Output<String> id, DatabaseInstanceState state, CustomResourceOptions options)
    resources:  _:    type: databricks:DatabaseInstance    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    ChildInstanceRefs List<DatabaseInstanceChildInstanceRef>
    (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)
    EnableReadableSecondaries bool
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    Name string
    The name of the instance. This is the unique identifier for the instance
    NodeCount int
    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef DatabaseInstanceParentInstanceRef
    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
    PurgeOnDelete bool
    Purge the resource on delete
    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
    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
    Whether the instance is stopped
    Uid string
    (string) - Id of the ref database instance
    Capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    ChildInstanceRefs []DatabaseInstanceChildInstanceRefArgs
    (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)
    EnableReadableSecondaries bool
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    Name string
    The name of the instance. This is the unique identifier for the instance
    NodeCount int
    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    ParentInstanceRef DatabaseInstanceParentInstanceRefArgs
    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
    PurgeOnDelete bool
    Purge the resource on delete
    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
    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
    Whether the instance is stopped
    Uid string
    (string) - Id of the ref database instance
    capacity String
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    childInstanceRefs List<DatabaseInstanceChildInstanceRef>
    (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)
    enableReadableSecondaries Boolean
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name String
    The name of the instance. This is the unique identifier for the instance
    nodeCount 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 DatabaseInstanceParentInstanceRef
    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
    purgeOnDelete Boolean
    Purge the resource on delete
    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
    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
    Whether the instance is stopped
    uid String
    (string) - Id of the ref database instance
    capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    childInstanceRefs DatabaseInstanceChildInstanceRef[]
    (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)
    enableReadableSecondaries boolean
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name string
    The name of the instance. This is the unique identifier for the instance
    nodeCount number
    The number of nodes in the instance, composed of 1 primary and 0 or more secondaries. Defaults to 1 primary and 0 secondaries
    parentInstanceRef DatabaseInstanceParentInstanceRef
    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
    purgeOnDelete boolean
    Purge the resource on delete
    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
    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
    Whether the instance is stopped
    uid string
    (string) - Id of the ref database instance
    capacity str
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    child_instance_refs Sequence[DatabaseInstanceChildInstanceRefArgs]
    (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)
    enable_readable_secondaries bool
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name str
    The name of the instance. This is the unique identifier for the instance
    node_count int
    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 DatabaseInstanceParentInstanceRefArgs
    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
    purge_on_delete bool
    Purge the resource on delete
    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
    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
    Whether the instance is stopped
    uid str
    (string) - Id of the ref database instance
    capacity 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
    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)
    enableReadableSecondaries Boolean
    Whether to enable secondaries to serve read-only traffic. Defaults to false
    name String
    The name of the instance. This is the unique identifier for the instance
    nodeCount Number
    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
    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
    purgeOnDelete Boolean
    Purge the resource on delete
    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
    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
    Whether the instance is stopped
    uid String
    (string) - Id of the ref database instance

    Supporting Types

    DatabaseInstanceChildInstanceRef, DatabaseInstanceChildInstanceRefArgs

    BranchTime 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
    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
    Lsn string

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    Uid string
    (string) - Id of the ref database instance
    BranchTime 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
    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
    Lsn string

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    Uid string
    (string) - Id of the ref database instance
    branchTime 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
    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
    lsn String

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid String
    (string) - Id of the ref database instance
    branchTime 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
    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
    lsn string

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid string
    (string) - Id of the ref database instance
    branch_time str
    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
    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
    lsn str

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid str
    (string) - Id of the ref database instance
    branchTime 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
    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
    lsn String

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid String
    (string) - Id of the ref database instance

    DatabaseInstanceParentInstanceRef, DatabaseInstanceParentInstanceRefArgs

    BranchTime 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
    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
    Lsn string

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    Uid string
    (string) - Id of the ref database instance
    BranchTime 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
    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
    Lsn string

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    Uid string
    (string) - Id of the ref database instance
    branchTime 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
    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
    lsn String

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid String
    (string) - Id of the ref database instance
    branchTime 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
    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
    lsn string

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid string
    (string) - Id of the ref database instance
    branch_time str
    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
    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
    lsn str

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid str
    (string) - Id of the ref database instance
    branchTime 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
    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
    lsn String

    User-specified WAL LSN of the ref database instance.

    Input: For specifying the WAL LSN 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
    uid String
    (string) - Id of the ref database instance

    Import

    As of Pulumi v1.5, resources can be imported through configuration.

    hcl

    import {

    id = name

    to = databricks_database_instance.this

    }

    If you are using an older version of Pulumi, import the resource using the pulumi import command as follows:

    $ pulumi import databricks:index/databaseInstance:DatabaseInstance databricks_database_instance name

    To learn more about importing existing cloud resources, see Importing resources.

    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