1. Packages
  2. Databricks Provider
  3. API Docs
  4. DatabaseInstance
Databricks v1.78.0 published on Friday, Nov 7, 2025 by Pulumi
pulumi/pulumi-databricks

databricks.DatabaseInstance

Start a Neo task
Explain and create a databricks.DatabaseInstance resource
databricks logo
Databricks v1.78.0 published on Friday, Nov 7, 2025 by Pulumi
pulumi/pulumi-databricks

    Public Preview

    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

    Example with a usage policy and custom tags

    This example creates a Database Instance with an associated usage policy and custom tags.

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

const _this = new databricks.DatabaseInstance("this", {
    name: "my-database-instance",
    capacity: "CU_8",
    usagePolicyId: "948192fa-a98b-498f-a09b-ecee79d8b983",
    customTags: [
        {
            key: "custom_tag_key1",
            value: "custom_tag_value1",
        },
        {
            key: "custom_tag_key2",
            value: "custom_tag_value2",
        },
    ],
});

    import pulumi
import pulumi_databricks as databricks

this = databricks.DatabaseInstance("this",
    name="my-database-instance",
    capacity="CU_8",
    usage_policy_id="948192fa-a98b-498f-a09b-ecee79d8b983",
    custom_tags=[
        {
            "key": "custom_tag_key1",
            "value": "custom_tag_value1",
        },
        {
            "key": "custom_tag_key2",
            "value": "custom_tag_value2",
        },
    ])

    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_8"),
			UsagePolicyId: pulumi.String("948192fa-a98b-498f-a09b-ecee79d8b983"),
			CustomTags: databricks.DatabaseInstanceCustomTagArray{
				&databricks.DatabaseInstanceCustomTagArgs{
					Key:   pulumi.String("custom_tag_key1"),
					Value: pulumi.String("custom_tag_value1"),
				},
				&databricks.DatabaseInstanceCustomTagArgs{
					Key:   pulumi.String("custom_tag_key2"),
					Value: pulumi.String("custom_tag_value2"),
				},
			},
		})
		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_8",
        UsagePolicyId = "948192fa-a98b-498f-a09b-ecee79d8b983",
        CustomTags = new[]
        {
            new Databricks.Inputs.DatabaseInstanceCustomTagArgs
            {
                Key = "custom_tag_key1",
                Value = "custom_tag_value1",
            },
            new Databricks.Inputs.DatabaseInstanceCustomTagArgs
            {
                Key = "custom_tag_key2",
                Value = "custom_tag_value2",
            },
        },
    });

});

    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.DatabaseInstanceCustomTagArgs;
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_8")
            .usagePolicyId("948192fa-a98b-498f-a09b-ecee79d8b983")
            .customTags(            
                DatabaseInstanceCustomTagArgs.builder()
                    .key("custom_tag_key1")
                    .value("custom_tag_value1")
                    .build(),
                DatabaseInstanceCustomTagArgs.builder()
                    .key("custom_tag_key2")
                    .value("custom_tag_value2")
                    .build())
            .build());

    }
}

    resources:
  this:
    type: databricks:DatabaseInstance
    properties:
      name: my-database-instance
      capacity: CU_8
      usagePolicyId: 948192fa-a98b-498f-a09b-ecee79d8b983
      customTags:
        - key: custom_tag_key1
          value: custom_tag_value1
        - key: custom_tag_key2
          value: custom_tag_value2

    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,
                     custom_tags: Optional[Sequence[DatabaseInstanceCustomTagArgs]] = None,
                     enable_pg_native_login: Optional[bool] = 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,
                     usage_policy_id: Optional[str] = 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",
    CustomTags = new[]
    {
        new Databricks.Inputs.DatabaseInstanceCustomTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    EnablePgNativeLogin = false,
    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,
    UsagePolicyId = "string",
});

    example, err := databricks.NewDatabaseInstance(ctx, "databaseInstanceResource", &databricks.DatabaseInstanceArgs{
	Capacity: pulumi.String("string"),
	CustomTags: databricks.DatabaseInstanceCustomTagArray{
		&databricks.DatabaseInstanceCustomTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	EnablePgNativeLogin:       pulumi.Bool(false),
	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),
	UsagePolicyId:         pulumi.String("string"),
})

    var databaseInstanceResource = new DatabaseInstance("databaseInstanceResource", DatabaseInstanceArgs.builder()
    .capacity("string")
    .customTags(DatabaseInstanceCustomTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .enablePgNativeLogin(false)
    .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)
    .usagePolicyId("string")
    .build());

    database_instance_resource = databricks.DatabaseInstance("databaseInstanceResource",
    capacity="string",
    custom_tags=[{
        "key": "string",
        "value": "string",
    }],
    enable_pg_native_login=False,
    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,
    usage_policy_id="string")

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

    type: databricks:DatabaseInstance
properties:
    capacity: string
    customTags:
        - key: string
          value: string
    enablePgNativeLogin: false
    enableReadableSecondaries: false
    name: string
    nodeCount: 0
    parentInstanceRef:
        branchTime: string
        effectiveLsn: string
        lsn: string
        name: string
        uid: string
    purgeOnDelete: false
    retentionWindowInDays: 0
    stopped: false
    usagePolicyId: string

    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"
    CustomTags List<DatabaseInstanceCustomTag>
    Custom tags associated with the instance. This field is only included on create and update responses
    EnablePgNativeLogin bool
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 to stop the instance. An input only param, see effective_stopped for the output
    UsagePolicyId string
    The desired usage policy to associate with the instance
    Capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    CustomTags []DatabaseInstanceCustomTagArgs
    Custom tags associated with the instance. This field is only included on create and update responses
    EnablePgNativeLogin bool
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 to stop the instance. An input only param, see effective_stopped for the output
    UsagePolicyId string
    The desired usage policy to associate with the instance
    capacity String
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    customTags List<DatabaseInstanceCustomTag>
    Custom tags associated with the instance. This field is only included on create and update responses
    enablePgNativeLogin Boolean
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 to stop the instance. An input only param, see effective_stopped for the output
    usagePolicyId String
    The desired usage policy to associate with the instance
    capacity string
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    customTags DatabaseInstanceCustomTag[]
    Custom tags associated with the instance. This field is only included on create and update responses
    enablePgNativeLogin boolean
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 to stop the instance. An input only param, see effective_stopped for the output
    usagePolicyId string
    The desired usage policy to associate with the instance
    capacity str
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    custom_tags Sequence[DatabaseInstanceCustomTagArgs]
    Custom tags associated with the instance. This field is only included on create and update responses
    enable_pg_native_login bool
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 to stop the instance. An input only param, see effective_stopped for the output
    usage_policy_id str
    The desired usage policy to associate with the instance
    capacity String
    The sku of the instance. Valid values are "CU_1", "CU_2", "CU_4", "CU_8"
    customTags List<Property Map>
    Custom tags associated with the instance. This field is only included on create and update responses
    enablePgNativeLogin Boolean
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 to stop the instance. An input only param, see effective_stopped for the output
    usagePolicyId String
    The desired usage policy to associate with the instance

    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
    EffectiveCapacity string
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
    EffectiveCustomTags List<DatabaseInstanceEffectiveCustomTag>
    (list of CustomTag) - The recorded custom tags associated with the instance
    EffectiveEnablePgNativeLogin bool
    (boolean) - Whether the instance has PG native password login enabled
    EffectiveEnableReadableSecondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    EffectiveRetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    EffectiveStopped bool
    (boolean) - Whether the instance is stopped
    EffectiveUsagePolicyId string
    (string) - The policy that is applied to the instance
    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
    EffectiveCapacity string
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
    EffectiveCustomTags []DatabaseInstanceEffectiveCustomTag
    (list of CustomTag) - The recorded custom tags associated with the instance
    EffectiveEnablePgNativeLogin bool
    (boolean) - Whether the instance has PG native password login enabled
    EffectiveEnableReadableSecondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    EffectiveRetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    EffectiveStopped bool
    (boolean) - Whether the instance is stopped
    EffectiveUsagePolicyId string
    (string) - The policy that is applied to the instance
    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
    effectiveCapacity String
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
    effectiveCustomTags List<DatabaseInstanceEffectiveCustomTag>
    (list of CustomTag) - The recorded custom tags associated with the instance
    effectiveEnablePgNativeLogin Boolean
    (boolean) - Whether the instance has PG native password login enabled
    effectiveEnableReadableSecondaries Boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    effectiveRetentionWindowInDays Integer
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    effectiveStopped Boolean
    (boolean) - Whether the instance is stopped
    effectiveUsagePolicyId String
    (string) - The policy that is applied to the instance
    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
    effectiveCapacity string
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
    effectiveCustomTags DatabaseInstanceEffectiveCustomTag[]
    (list of CustomTag) - The recorded custom tags associated with the instance
    effectiveEnablePgNativeLogin boolean
    (boolean) - Whether the instance has PG native password login enabled
    effectiveEnableReadableSecondaries boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    effectiveRetentionWindowInDays number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    effectiveStopped boolean
    (boolean) - Whether the instance is stopped
    effectiveUsagePolicyId string
    (string) - The policy that is applied to the instance
    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_capacity str
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
    effective_custom_tags Sequence[DatabaseInstanceEffectiveCustomTag]
    (list of CustomTag) - The recorded custom tags associated with the instance
    effective_enable_pg_native_login bool
    (boolean) - Whether the instance has PG native password login enabled
    effective_enable_readable_secondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    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
    effective_stopped bool
    (boolean) - Whether the instance is stopped
    effective_usage_policy_id str
    (string) - The policy that is applied to the instance
    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
    effectiveCapacity String
    (string, deprecated) - Deprecated. The sku of the instance; this field will always match the value of capacity
    effectiveCustomTags List<Property Map>
    (list of CustomTag) - The recorded custom tags associated with the instance
    effectiveEnablePgNativeLogin Boolean
    (boolean) - Whether the instance has PG native password login enabled
    effectiveEnableReadableSecondaries Boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    effectiveRetentionWindowInDays Number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    effectiveStopped Boolean
    (boolean) - Whether the instance is stopped
    effectiveUsagePolicyId String
    (string) - The policy that is applied to the instance
    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,
        custom_tags: Optional[Sequence[DatabaseInstanceCustomTagArgs]] = None,
        effective_capacity: Optional[str] = None,
        effective_custom_tags: Optional[Sequence[DatabaseInstanceEffectiveCustomTagArgs]] = None,
        effective_enable_pg_native_login: Optional[bool] = 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,
        effective_usage_policy_id: Optional[str] = None,
        enable_pg_native_login: 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,
        usage_policy_id: 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
    CustomTags List<DatabaseInstanceCustomTag>
    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
    EffectiveCustomTags List<DatabaseInstanceEffectiveCustomTag>
    (list of CustomTag) - The recorded custom tags associated with the instance
    EffectiveEnablePgNativeLogin bool
    (boolean) - Whether the instance has PG native password login enabled
    EffectiveEnableReadableSecondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    EffectiveRetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    EffectiveStopped bool
    (boolean) - Whether the instance is stopped
    EffectiveUsagePolicyId string
    (string) - The policy that is applied to the instance
    EnablePgNativeLogin bool
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 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
    The desired usage policy to associate with the 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
    CustomTags []DatabaseInstanceCustomTagArgs
    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
    EffectiveCustomTags []DatabaseInstanceEffectiveCustomTagArgs
    (list of CustomTag) - The recorded custom tags associated with the instance
    EffectiveEnablePgNativeLogin bool
    (boolean) - Whether the instance has PG native password login enabled
    EffectiveEnableReadableSecondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    EffectiveRetentionWindowInDays int
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    EffectiveStopped bool
    (boolean) - Whether the instance is stopped
    EffectiveUsagePolicyId string
    (string) - The policy that is applied to the instance
    EnablePgNativeLogin bool
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 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
    The desired usage policy to associate with the 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
    customTags List<DatabaseInstanceCustomTag>
    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
    effectiveCustomTags List<DatabaseInstanceEffectiveCustomTag>
    (list of CustomTag) - The recorded custom tags associated with the instance
    effectiveEnablePgNativeLogin Boolean
    (boolean) - Whether the instance has PG native password login enabled
    effectiveEnableReadableSecondaries Boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    effectiveRetentionWindowInDays Integer
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    effectiveStopped Boolean
    (boolean) - Whether the instance is stopped
    effectiveUsagePolicyId String
    (string) - The policy that is applied to the instance
    enablePgNativeLogin Boolean
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 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
    The desired usage policy to associate with the 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
    customTags DatabaseInstanceCustomTag[]
    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
    effectiveCustomTags DatabaseInstanceEffectiveCustomTag[]
    (list of CustomTag) - The recorded custom tags associated with the instance
    effectiveEnablePgNativeLogin boolean
    (boolean) - Whether the instance has PG native password login enabled
    effectiveEnableReadableSecondaries boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    effectiveRetentionWindowInDays number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    effectiveStopped boolean
    (boolean) - Whether the instance is stopped
    effectiveUsagePolicyId string
    (string) - The policy that is applied to the instance
    enablePgNativeLogin boolean
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 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
    The desired usage policy to associate with the 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
    custom_tags Sequence[DatabaseInstanceCustomTagArgs]
    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
    effective_custom_tags Sequence[DatabaseInstanceEffectiveCustomTagArgs]
    (list of CustomTag) - The recorded custom tags associated with the instance
    effective_enable_pg_native_login bool
    (boolean) - Whether the instance has PG native password login enabled
    effective_enable_readable_secondaries bool
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    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
    effective_stopped bool
    (boolean) - Whether the instance is stopped
    effective_usage_policy_id str
    (string) - The policy that is applied to the instance
    enable_pg_native_login bool
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 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
    The desired usage policy to associate with the 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
    customTags List<Property Map>
    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
    effectiveCustomTags List<Property Map>
    (list of CustomTag) - The recorded custom tags associated with the instance
    effectiveEnablePgNativeLogin Boolean
    (boolean) - Whether the instance has PG native password login enabled
    effectiveEnableReadableSecondaries Boolean
    (boolean) - Whether secondaries serving read-only traffic are enabled. Defaults to false
    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
    effectiveRetentionWindowInDays Number
    (integer) - The retention window for the instance. This is the time window in days for which the historical data is retained
    effectiveStopped Boolean
    (boolean) - Whether the instance is stopped
    effectiveUsagePolicyId String
    (string) - The policy that is applied to the instance
    enablePgNativeLogin Boolean
    Whether to enable PG native password login on the instance. Defaults to false
    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. This field is input only, see effective_node_count for the output
    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 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
    The desired usage policy to associate with the 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) - 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) - 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) - 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) - 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) - 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) - 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

    DatabaseInstanceCustomTag, DatabaseInstanceCustomTagArgs

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

    DatabaseInstanceEffectiveCustomTag, DatabaseInstanceEffectiveCustomTagArgs

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

    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) - 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) - 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) - 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) - 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) - 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) - 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 this "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.78.0 published on Friday, Nov 7, 2025 by Pulumi
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate