1. Packages
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. DbInstance
Viewing docs for Harness v0.14.6
published on Thursday, Jul 9, 2026 by Pulumi
harness logo
Viewing docs for Harness v0.14.6
published on Thursday, Jul 9, 2026 by Pulumi

    Resource for creating a Harness DBDevOps Instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const test = new harness.platform.DbInstance("test", {
        identifier: "identifier",
        orgId: "org_id",
        projectId: "project_id",
        name: "name",
        tags: [
            "foo:bar",
            "bar:foo",
        ],
        schema: "schema1",
        branch: "main",
        connector: "jdbcConnector",
        context: "ctx",
        substituteProperties: {
            key1: "value1",
            key2: "value2",
        },
    });
    // Using commit_sha to pin changelog to a specific revision
    const withCommitSha = new harness.platform.DbInstance("with_commit_sha", {
        identifier: "identifier",
        orgId: "org_id",
        projectId: "project_id",
        name: "name",
        tags: [
            "foo:bar",
            "bar:foo",
        ],
        schema: "schema1",
        commitSha: "abc123def456",
        connector: "jdbcConnector",
        context: "ctx",
    });
    // Using git_tag to pin changelog to a specific tagged revision
    const withGitTag = new harness.platform.DbInstance("with_git_tag", {
        identifier: "identifier",
        orgId: "org_id",
        projectId: "project_id",
        name: "name",
        tags: [
            "foo:bar",
            "bar:foo",
        ],
        schema: "schema1",
        gitTag: "v1.0.0",
        connector: "jdbcConnector",
        context: "ctx",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    test = harness.platform.DbInstance("test",
        identifier="identifier",
        org_id="org_id",
        project_id="project_id",
        name="name",
        tags=[
            "foo:bar",
            "bar:foo",
        ],
        schema="schema1",
        branch="main",
        connector="jdbcConnector",
        context="ctx",
        substitute_properties={
            "key1": "value1",
            "key2": "value2",
        })
    # Using commit_sha to pin changelog to a specific revision
    with_commit_sha = harness.platform.DbInstance("with_commit_sha",
        identifier="identifier",
        org_id="org_id",
        project_id="project_id",
        name="name",
        tags=[
            "foo:bar",
            "bar:foo",
        ],
        schema="schema1",
        commit_sha="abc123def456",
        connector="jdbcConnector",
        context="ctx")
    # Using git_tag to pin changelog to a specific tagged revision
    with_git_tag = harness.platform.DbInstance("with_git_tag",
        identifier="identifier",
        org_id="org_id",
        project_id="project_id",
        name="name",
        tags=[
            "foo:bar",
            "bar:foo",
        ],
        schema="schema1",
        git_tag="v1.0.0",
        connector="jdbcConnector",
        context="ctx")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.NewDbInstance(ctx, "test", &platform.DbInstanceArgs{
    			Identifier: pulumi.String("identifier"),
    			OrgId:      pulumi.String("org_id"),
    			ProjectId:  pulumi.String("project_id"),
    			Name:       pulumi.String("name"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("bar:foo"),
    			},
    			Schema:    pulumi.String("schema1"),
    			Branch:    pulumi.String("main"),
    			Connector: pulumi.String("jdbcConnector"),
    			Context:   pulumi.String("ctx"),
    			SubstituteProperties: pulumi.StringMap{
    				"key1": pulumi.String("value1"),
    				"key2": pulumi.String("value2"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		// Using commit_sha to pin changelog to a specific revision
    		_, err = platform.NewDbInstance(ctx, "with_commit_sha", &platform.DbInstanceArgs{
    			Identifier: pulumi.String("identifier"),
    			OrgId:      pulumi.String("org_id"),
    			ProjectId:  pulumi.String("project_id"),
    			Name:       pulumi.String("name"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("bar:foo"),
    			},
    			Schema:    pulumi.String("schema1"),
    			CommitSha: pulumi.String("abc123def456"),
    			Connector: pulumi.String("jdbcConnector"),
    			Context:   pulumi.String("ctx"),
    		})
    		if err != nil {
    			return err
    		}
    		// Using git_tag to pin changelog to a specific tagged revision
    		_, err = platform.NewDbInstance(ctx, "with_git_tag", &platform.DbInstanceArgs{
    			Identifier: pulumi.String("identifier"),
    			OrgId:      pulumi.String("org_id"),
    			ProjectId:  pulumi.String("project_id"),
    			Name:       pulumi.String("name"),
    			Tags: pulumi.StringArray{
    				pulumi.String("foo:bar"),
    				pulumi.String("bar:foo"),
    			},
    			Schema:    pulumi.String("schema1"),
    			GitTag:    pulumi.String("v1.0.0"),
    			Connector: pulumi.String("jdbcConnector"),
    			Context:   pulumi.String("ctx"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Harness.Platform.DbInstance("test", new()
        {
            Identifier = "identifier",
            OrgId = "org_id",
            ProjectId = "project_id",
            Name = "name",
            Tags = new[]
            {
                "foo:bar",
                "bar:foo",
            },
            Schema = "schema1",
            Branch = "main",
            Connector = "jdbcConnector",
            Context = "ctx",
            SubstituteProperties = 
            {
                { "key1", "value1" },
                { "key2", "value2" },
            },
        });
    
        // Using commit_sha to pin changelog to a specific revision
        var withCommitSha = new Harness.Platform.DbInstance("with_commit_sha", new()
        {
            Identifier = "identifier",
            OrgId = "org_id",
            ProjectId = "project_id",
            Name = "name",
            Tags = new[]
            {
                "foo:bar",
                "bar:foo",
            },
            Schema = "schema1",
            CommitSha = "abc123def456",
            Connector = "jdbcConnector",
            Context = "ctx",
        });
    
        // Using git_tag to pin changelog to a specific tagged revision
        var withGitTag = new Harness.Platform.DbInstance("with_git_tag", new()
        {
            Identifier = "identifier",
            OrgId = "org_id",
            ProjectId = "project_id",
            Name = "name",
            Tags = new[]
            {
                "foo:bar",
                "bar:foo",
            },
            Schema = "schema1",
            GitTag = "v1.0.0",
            Connector = "jdbcConnector",
            Context = "ctx",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.DbInstance;
    import com.pulumi.harness.platform.DbInstanceArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 test = new DbInstance("test", DbInstanceArgs.builder()
                .identifier("identifier")
                .orgId("org_id")
                .projectId("project_id")
                .name("name")
                .tags(            
                    "foo:bar",
                    "bar:foo")
                .schema("schema1")
                .branch("main")
                .connector("jdbcConnector")
                .context("ctx")
                .substituteProperties(Map.ofEntries(
                    Map.entry("key1", "value1"),
                    Map.entry("key2", "value2")
                ))
                .build());
    
            // Using commit_sha to pin changelog to a specific revision
            var withCommitSha = new DbInstance("withCommitSha", DbInstanceArgs.builder()
                .identifier("identifier")
                .orgId("org_id")
                .projectId("project_id")
                .name("name")
                .tags(            
                    "foo:bar",
                    "bar:foo")
                .schema("schema1")
                .commitSha("abc123def456")
                .connector("jdbcConnector")
                .context("ctx")
                .build());
    
            // Using git_tag to pin changelog to a specific tagged revision
            var withGitTag = new DbInstance("withGitTag", DbInstanceArgs.builder()
                .identifier("identifier")
                .orgId("org_id")
                .projectId("project_id")
                .name("name")
                .tags(            
                    "foo:bar",
                    "bar:foo")
                .schema("schema1")
                .gitTag("v1.0.0")
                .connector("jdbcConnector")
                .context("ctx")
                .build());
    
        }
    }
    
    resources:
      test:
        type: harness:platform:DbInstance
        properties:
          identifier: identifier
          orgId: org_id
          projectId: project_id
          name: name
          tags:
            - foo:bar
            - bar:foo
          schema: schema1
          branch: main
          connector: jdbcConnector
          context: ctx
          substituteProperties:
            key1: value1
            key2: value2
      # Using commit_sha to pin changelog to a specific revision
      withCommitSha:
        type: harness:platform:DbInstance
        name: with_commit_sha
        properties:
          identifier: identifier
          orgId: org_id
          projectId: project_id
          name: name
          tags:
            - foo:bar
            - bar:foo
          schema: schema1
          commitSha: abc123def456
          connector: jdbcConnector
          context: ctx
      # Using git_tag to pin changelog to a specific tagged revision
      withGitTag:
        type: harness:platform:DbInstance
        name: with_git_tag
        properties:
          identifier: identifier
          orgId: org_id
          projectId: project_id
          name: name
          tags:
            - foo:bar
            - bar:foo
          schema: schema1
          gitTag: v1.0.0
          connector: jdbcConnector
          context: ctx
    
    pulumi {
      required_providers {
        harness = {
          source = "pulumi/harness"
        }
      }
    }
    
    resource "harness_platform_dbinstance" "test" {
      identifier = "identifier"
      org_id     = "org_id"
      project_id = "project_id"
      name       = "name"
      tags       = ["foo:bar", "bar:foo"]
      schema     = "schema1"
      branch     = "main"
      connector  = "jdbcConnector"
      context    = "ctx"
      substitute_properties = {
        "key1" = "value1"
        "key2" = "value2"
      }
    }
    # Using commit_sha to pin changelog to a specific revision
    resource "harness_platform_dbinstance" "with_commit_sha" {
      identifier = "identifier"
      org_id     = "org_id"
      project_id = "project_id"
      name       = "name"
      tags       = ["foo:bar", "bar:foo"]
      schema     = "schema1"
      commit_sha = "abc123def456"
      connector  = "jdbcConnector"
      context    = "ctx"
    }
    # Using git_tag to pin changelog to a specific tagged revision
    resource "harness_platform_dbinstance" "with_git_tag" {
      identifier = "identifier"
      org_id     = "org_id"
      project_id = "project_id"
      name       = "name"
      tags       = ["foo:bar", "bar:foo"]
      schema     = "schema1"
      git_tag    = "v1.0.0"
      connector  = "jdbcConnector"
      context    = "ctx"
    }
    

    Create DbInstance Resource

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

    Constructor syntax

    new DbInstance(name: string, args: DbInstanceArgs, opts?: CustomResourceOptions);
    @overload
    def DbInstance(resource_name: str,
                   args: DbInstanceArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def DbInstance(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project_id: Optional[str] = None,
                   connector: Optional[str] = None,
                   identifier: Optional[str] = None,
                   org_id: Optional[str] = None,
                   schema: Optional[str] = None,
                   commit_sha: Optional[str] = None,
                   context: Optional[str] = None,
                   description: Optional[str] = None,
                   git_tag: Optional[str] = None,
                   name: Optional[str] = None,
                   branch: Optional[str] = None,
                   substitute_properties: Optional[Mapping[str, str]] = None,
                   tags: Optional[Sequence[str]] = None)
    func NewDbInstance(ctx *Context, name string, args DbInstanceArgs, opts ...ResourceOption) (*DbInstance, error)
    public DbInstance(string name, DbInstanceArgs args, CustomResourceOptions? opts = null)
    public DbInstance(String name, DbInstanceArgs args)
    public DbInstance(String name, DbInstanceArgs args, CustomResourceOptions options)
    
    type: harness:platform:DbInstance
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "harness_platform_dbinstance" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DbInstanceArgs
    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 DbInstanceArgs
    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 DbInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbInstanceArgs
    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 dbInstanceResource = new Harness.Platform.DbInstance("dbInstanceResource", new()
    {
        ProjectId = "string",
        Connector = "string",
        Identifier = "string",
        OrgId = "string",
        Schema = "string",
        CommitSha = "string",
        Context = "string",
        Description = "string",
        GitTag = "string",
        Name = "string",
        Branch = "string",
        SubstituteProperties = 
        {
            { "string", "string" },
        },
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := platform.NewDbInstance(ctx, "dbInstanceResource", &platform.DbInstanceArgs{
    	ProjectId:   pulumi.String("string"),
    	Connector:   pulumi.String("string"),
    	Identifier:  pulumi.String("string"),
    	OrgId:       pulumi.String("string"),
    	Schema:      pulumi.String("string"),
    	CommitSha:   pulumi.String("string"),
    	Context:     pulumi.String("string"),
    	Description: pulumi.String("string"),
    	GitTag:      pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Branch:      pulumi.String("string"),
    	SubstituteProperties: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "harness_platform_dbinstance" "dbInstanceResource" {
      project_id  = "string"
      connector   = "string"
      identifier  = "string"
      org_id      = "string"
      schema      = "string"
      commit_sha  = "string"
      context     = "string"
      description = "string"
      git_tag     = "string"
      name        = "string"
      branch      = "string"
      substitute_properties = {
        "string" = "string"
      }
      tags = ["string"]
    }
    
    var dbInstanceResource = new DbInstance("dbInstanceResource", DbInstanceArgs.builder()
        .projectId("string")
        .connector("string")
        .identifier("string")
        .orgId("string")
        .schema("string")
        .commitSha("string")
        .context("string")
        .description("string")
        .gitTag("string")
        .name("string")
        .branch("string")
        .substituteProperties(Map.of("string", "string"))
        .tags("string")
        .build());
    
    db_instance_resource = harness.platform.DbInstance("dbInstanceResource",
        project_id="string",
        connector="string",
        identifier="string",
        org_id="string",
        schema="string",
        commit_sha="string",
        context="string",
        description="string",
        git_tag="string",
        name="string",
        branch="string",
        substitute_properties={
            "string": "string",
        },
        tags=["string"])
    
    const dbInstanceResource = new harness.platform.DbInstance("dbInstanceResource", {
        projectId: "string",
        connector: "string",
        identifier: "string",
        orgId: "string",
        schema: "string",
        commitSha: "string",
        context: "string",
        description: "string",
        gitTag: "string",
        name: "string",
        branch: "string",
        substituteProperties: {
            string: "string",
        },
        tags: ["string"],
    });
    
    type: harness:platform:DbInstance
    properties:
        branch: string
        commitSha: string
        connector: string
        context: string
        description: string
        gitTag: string
        identifier: string
        name: string
        orgId: string
        projectId: string
        schema: string
        substituteProperties:
            string: string
        tags:
            - string
    

    DbInstance 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 DbInstance resource accepts the following input properties:

    Connector string
    The connector to database
    Identifier string
    Unique identifier of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Schema string
    The identifier of the parent database schema
    Branch string
    The branch of changeSet repository
    CommitSha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    Context string
    The liquibase context
    Description string
    Description of the resource.
    GitTag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    Name string
    Name of the resource.
    SubstituteProperties Dictionary<string, string>
    The properties to substitute in changelog migration script
    Tags List<string>
    Tags to associate with the resource.
    Connector string
    The connector to database
    Identifier string
    Unique identifier of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Schema string
    The identifier of the parent database schema
    Branch string
    The branch of changeSet repository
    CommitSha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    Context string
    The liquibase context
    Description string
    Description of the resource.
    GitTag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    Name string
    Name of the resource.
    SubstituteProperties map[string]string
    The properties to substitute in changelog migration script
    Tags []string
    Tags to associate with the resource.
    connector string
    The connector to database
    identifier string
    Unique identifier of the resource.
    org_id string
    Unique identifier of the organization.
    project_id string
    Unique identifier of the project.
    schema string
    The identifier of the parent database schema
    branch string
    The branch of changeSet repository
    commit_sha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    context string
    The liquibase context
    description string
    Description of the resource.
    git_tag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    name string
    Name of the resource.
    substitute_properties map(string)
    The properties to substitute in changelog migration script
    tags list(string)
    Tags to associate with the resource.
    connector String
    The connector to database
    identifier String
    Unique identifier of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    schema String
    The identifier of the parent database schema
    branch String
    The branch of changeSet repository
    commitSha String
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    context String
    The liquibase context
    description String
    Description of the resource.
    gitTag String
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    name String
    Name of the resource.
    substituteProperties Map<String,String>
    The properties to substitute in changelog migration script
    tags List<String>
    Tags to associate with the resource.
    connector string
    The connector to database
    identifier string
    Unique identifier of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    schema string
    The identifier of the parent database schema
    branch string
    The branch of changeSet repository
    commitSha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    context string
    The liquibase context
    description string
    Description of the resource.
    gitTag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    name string
    Name of the resource.
    substituteProperties {[key: string]: string}
    The properties to substitute in changelog migration script
    tags string[]
    Tags to associate with the resource.
    connector str
    The connector to database
    identifier str
    Unique identifier of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    schema str
    The identifier of the parent database schema
    branch str
    The branch of changeSet repository
    commit_sha str
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    context str
    The liquibase context
    description str
    Description of the resource.
    git_tag str
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    name str
    Name of the resource.
    substitute_properties Mapping[str, str]
    The properties to substitute in changelog migration script
    tags Sequence[str]
    Tags to associate with the resource.
    connector String
    The connector to database
    identifier String
    Unique identifier of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    schema String
    The identifier of the parent database schema
    branch String
    The branch of changeSet repository
    commitSha String
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    context String
    The liquibase context
    description String
    Description of the resource.
    gitTag String
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    name String
    Name of the resource.
    substituteProperties Map<String>
    The properties to substitute in changelog migration script
    tags List<String>
    Tags to associate with the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DbInstance Resource

    Get an existing DbInstance 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?: DbInstanceState, opts?: CustomResourceOptions): DbInstance
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            branch: Optional[str] = None,
            commit_sha: Optional[str] = None,
            connector: Optional[str] = None,
            context: Optional[str] = None,
            description: Optional[str] = None,
            git_tag: Optional[str] = None,
            identifier: Optional[str] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            project_id: Optional[str] = None,
            schema: Optional[str] = None,
            substitute_properties: Optional[Mapping[str, str]] = None,
            tags: Optional[Sequence[str]] = None) -> DbInstance
    func GetDbInstance(ctx *Context, name string, id IDInput, state *DbInstanceState, opts ...ResourceOption) (*DbInstance, error)
    public static DbInstance Get(string name, Input<string> id, DbInstanceState? state, CustomResourceOptions? opts = null)
    public static DbInstance get(String name, Output<String> id, DbInstanceState state, CustomResourceOptions options)
    resources:  _:    type: harness:platform:DbInstance    get:      id: ${id}
    import {
      to = harness_platform_dbinstance.example
      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:
    Branch string
    The branch of changeSet repository
    CommitSha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    Connector string
    The connector to database
    Context string
    The liquibase context
    Description string
    Description of the resource.
    GitTag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Schema string
    The identifier of the parent database schema
    SubstituteProperties Dictionary<string, string>
    The properties to substitute in changelog migration script
    Tags List<string>
    Tags to associate with the resource.
    Branch string
    The branch of changeSet repository
    CommitSha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    Connector string
    The connector to database
    Context string
    The liquibase context
    Description string
    Description of the resource.
    GitTag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Schema string
    The identifier of the parent database schema
    SubstituteProperties map[string]string
    The properties to substitute in changelog migration script
    Tags []string
    Tags to associate with the resource.
    branch string
    The branch of changeSet repository
    commit_sha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    connector string
    The connector to database
    context string
    The liquibase context
    description string
    Description of the resource.
    git_tag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    org_id string
    Unique identifier of the organization.
    project_id string
    Unique identifier of the project.
    schema string
    The identifier of the parent database schema
    substitute_properties map(string)
    The properties to substitute in changelog migration script
    tags list(string)
    Tags to associate with the resource.
    branch String
    The branch of changeSet repository
    commitSha String
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    connector String
    The connector to database
    context String
    The liquibase context
    description String
    Description of the resource.
    gitTag String
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    schema String
    The identifier of the parent database schema
    substituteProperties Map<String,String>
    The properties to substitute in changelog migration script
    tags List<String>
    Tags to associate with the resource.
    branch string
    The branch of changeSet repository
    commitSha string
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    connector string
    The connector to database
    context string
    The liquibase context
    description string
    Description of the resource.
    gitTag string
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    schema string
    The identifier of the parent database schema
    substituteProperties {[key: string]: string}
    The properties to substitute in changelog migration script
    tags string[]
    Tags to associate with the resource.
    branch str
    The branch of changeSet repository
    commit_sha str
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    connector str
    The connector to database
    context str
    The liquibase context
    description str
    Description of the resource.
    git_tag str
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    schema str
    The identifier of the parent database schema
    substitute_properties Mapping[str, str]
    The properties to substitute in changelog migration script
    tags Sequence[str]
    Tags to associate with the resource.
    branch String
    The branch of changeSet repository
    commitSha String
    The commit SHA to pin the changelog to a specific revision. Mutually exclusive with branch and git_tag.
    connector String
    The connector to database
    context String
    The liquibase context
    description String
    Description of the resource.
    gitTag String
    The git tag to pin the changelog to a specific tagged revision. Mutually exclusive with branch and commit_sha.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    schema String
    The identifier of the parent database schema
    substituteProperties Map<String>
    The properties to substitute in changelog migration script
    tags List<String>
    Tags to associate with the resource.

    Import

    The pulumi import command can be used, for example:

    Import project level db instance

    $ pulumi import harness:platform/dbInstance:DbInstance example <org_id>/<project_id>/<db_schema_id>/<db_instance_id>
    

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

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.14.6
    published on Thursday, Jul 9, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial