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

databricks.PostgresBranch

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

    Private Preview

    Create PostgresBranch Resource

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

    Constructor syntax

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

@overload
def PostgresBranch(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   branch_id: Optional[str] = None,
                   parent: Optional[str] = None,
                   spec: Optional[PostgresBranchSpecArgs] = None)
    func NewPostgresBranch(ctx *Context, name string, args PostgresBranchArgs, opts ...ResourceOption) (*PostgresBranch, error)
    public PostgresBranch(string name, PostgresBranchArgs args, CustomResourceOptions? opts = null)
    public PostgresBranch(String name, PostgresBranchArgs args)
public PostgresBranch(String name, PostgresBranchArgs args, CustomResourceOptions options)

    type: databricks:PostgresBranch
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 PostgresBranchArgs
    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 PostgresBranchArgs
    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 PostgresBranchArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PostgresBranchArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PostgresBranchArgs
    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 postgresBranchResource = new Databricks.PostgresBranch("postgresBranchResource", new()
{
    BranchId = "string",
    Parent = "string",
    Spec = new Databricks.Inputs.PostgresBranchSpecArgs
    {
        Default = false,
        IsProtected = false,
        SourceBranch = "string",
        SourceBranchLsn = "string",
        SourceBranchTime = "string",
    },
});

    example, err := databricks.NewPostgresBranch(ctx, "postgresBranchResource", &databricks.PostgresBranchArgs{
	BranchId: pulumi.String("string"),
	Parent:   pulumi.String("string"),
	Spec: &databricks.PostgresBranchSpecArgs{
		Default:          pulumi.Bool(false),
		IsProtected:      pulumi.Bool(false),
		SourceBranch:     pulumi.String("string"),
		SourceBranchLsn:  pulumi.String("string"),
		SourceBranchTime: pulumi.String("string"),
	},
})

    var postgresBranchResource = new PostgresBranch("postgresBranchResource", PostgresBranchArgs.builder()
    .branchId("string")
    .parent("string")
    .spec(PostgresBranchSpecArgs.builder()
        .default_(false)
        .isProtected(false)
        .sourceBranch("string")
        .sourceBranchLsn("string")
        .sourceBranchTime("string")
        .build())
    .build());

    postgres_branch_resource = databricks.PostgresBranch("postgresBranchResource",
    branch_id="string",
    parent="string",
    spec={
        "default": False,
        "is_protected": False,
        "source_branch": "string",
        "source_branch_lsn": "string",
        "source_branch_time": "string",
    })

    const postgresBranchResource = new databricks.PostgresBranch("postgresBranchResource", {
    branchId: "string",
    parent: "string",
    spec: {
        "default": false,
        isProtected: false,
        sourceBranch: "string",
        sourceBranchLsn: "string",
        sourceBranchTime: "string",
    },
});

    type: databricks:PostgresBranch
properties:
    branchId: string
    parent: string
    spec:
        default: false
        isProtected: false
        sourceBranch: string
        sourceBranchLsn: string
        sourceBranchTime: string

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

    BranchId string

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    Parent string
    The project containing this branch. Format: projects/{project_id}
    Spec PostgresBranchSpec
    The desired state of a Branch
    BranchId string

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    Parent string
    The project containing this branch. Format: projects/{project_id}
    Spec PostgresBranchSpecArgs
    The desired state of a Branch
    branchId String

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    parent String
    The project containing this branch. Format: projects/{project_id}
    spec PostgresBranchSpec
    The desired state of a Branch
    branchId string

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    parent string
    The project containing this branch. Format: projects/{project_id}
    spec PostgresBranchSpec
    The desired state of a Branch
    branch_id str

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    parent str
    The project containing this branch. Format: projects/{project_id}
    spec PostgresBranchSpecArgs
    The desired state of a Branch
    branchId String

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    parent String
    The project containing this branch. Format: projects/{project_id}
    spec Property Map
    The desired state of a Branch

    Outputs

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

    CreateTime string
    (string) - A timestamp indicating when the branch was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    Status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    Uid string
    (string) - System generated unique ID for the branch
    UpdateTime string
    (string) - A timestamp indicating when the branch was last updated
    CreateTime string
    (string) - A timestamp indicating when the branch was created
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    Status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    Uid string
    (string) - System generated unique ID for the branch
    UpdateTime string
    (string) - A timestamp indicating when the branch was last updated
    createTime String
    (string) - A timestamp indicating when the branch was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    uid String
    (string) - System generated unique ID for the branch
    updateTime String
    (string) - A timestamp indicating when the branch was last updated
    createTime string
    (string) - A timestamp indicating when the branch was created
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    uid string
    (string) - System generated unique ID for the branch
    updateTime string
    (string) - A timestamp indicating when the branch was last updated
    create_time str
    (string) - A timestamp indicating when the branch was created
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    uid str
    (string) - System generated unique ID for the branch
    update_time str
    (string) - A timestamp indicating when the branch was last updated
    createTime String
    (string) - A timestamp indicating when the branch was created
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    status Property Map
    (BranchStatus) - The current status of a Branch
    uid String
    (string) - System generated unique ID for the branch
    updateTime String
    (string) - A timestamp indicating when the branch was last updated

    Look up Existing PostgresBranch Resource

    Get an existing PostgresBranch 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?: PostgresBranchState, opts?: CustomResourceOptions): PostgresBranch
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch_id: Optional[str] = None,
        create_time: Optional[str] = None,
        name: Optional[str] = None,
        parent: Optional[str] = None,
        spec: Optional[PostgresBranchSpecArgs] = None,
        status: Optional[PostgresBranchStatusArgs] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> PostgresBranch
    func GetPostgresBranch(ctx *Context, name string, id IDInput, state *PostgresBranchState, opts ...ResourceOption) (*PostgresBranch, error)
    public static PostgresBranch Get(string name, Input<string> id, PostgresBranchState? state, CustomResourceOptions? opts = null)
    public static PostgresBranch get(String name, Output<String> id, PostgresBranchState state, CustomResourceOptions options)
    resources:  _:    type: databricks:PostgresBranch    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:
    BranchId string

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    CreateTime string
    (string) - A timestamp indicating when the branch was created
    Name string
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    Parent string
    The project containing this branch. Format: projects/{project_id}
    Spec PostgresBranchSpec
    The desired state of a Branch
    Status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    Uid string
    (string) - System generated unique ID for the branch
    UpdateTime string
    (string) - A timestamp indicating when the branch was last updated
    BranchId string

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    CreateTime string
    (string) - A timestamp indicating when the branch was created
    Name string
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    Parent string
    The project containing this branch. Format: projects/{project_id}
    Spec PostgresBranchSpecArgs
    The desired state of a Branch
    Status PostgresBranchStatusArgs
    (BranchStatus) - The current status of a Branch
    Uid string
    (string) - System generated unique ID for the branch
    UpdateTime string
    (string) - A timestamp indicating when the branch was last updated
    branchId String

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    createTime String
    (string) - A timestamp indicating when the branch was created
    name String
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    parent String
    The project containing this branch. Format: projects/{project_id}
    spec PostgresBranchSpec
    The desired state of a Branch
    status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    uid String
    (string) - System generated unique ID for the branch
    updateTime String
    (string) - A timestamp indicating when the branch was last updated
    branchId string

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    createTime string
    (string) - A timestamp indicating when the branch was created
    name string
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    parent string
    The project containing this branch. Format: projects/{project_id}
    spec PostgresBranchSpec
    The desired state of a Branch
    status PostgresBranchStatus
    (BranchStatus) - The current status of a Branch
    uid string
    (string) - System generated unique ID for the branch
    updateTime string
    (string) - A timestamp indicating when the branch was last updated
    branch_id str

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    create_time str
    (string) - A timestamp indicating when the branch was created
    name str
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    parent str
    The project containing this branch. Format: projects/{project_id}
    spec PostgresBranchSpecArgs
    The desired state of a Branch
    status PostgresBranchStatusArgs
    (BranchStatus) - The current status of a Branch
    uid str
    (string) - System generated unique ID for the branch
    update_time str
    (string) - A timestamp indicating when the branch was last updated
    branchId String

    The ID to use for the Branch, which will become the final component of the branch's resource name.

    This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/

    createTime String
    (string) - A timestamp indicating when the branch was created
    name String
    (string) - The resource name of the branch. Format: projects/{project_id}/branches/{branch_id}
    parent String
    The project containing this branch. Format: projects/{project_id}
    spec Property Map
    The desired state of a Branch
    status Property Map
    (BranchStatus) - The current status of a Branch
    uid String
    (string) - System generated unique ID for the branch
    updateTime String
    (string) - A timestamp indicating when the branch was last updated

    Supporting Types

    PostgresBranchSpec, PostgresBranchSpecArgs

    Default bool
    (boolean) - Whether the branch is the project's default branch
    IsProtected bool
    (boolean) - Whether the branch is protected
    SourceBranch string
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    SourceBranchLsn string
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    SourceBranchTime string
    (string) - The point in time on the source branch from which this branch was created
    Default bool
    (boolean) - Whether the branch is the project's default branch
    IsProtected bool
    (boolean) - Whether the branch is protected
    SourceBranch string
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    SourceBranchLsn string
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    SourceBranchTime string
    (string) - The point in time on the source branch from which this branch was created
    default_ Boolean
    (boolean) - Whether the branch is the project's default branch
    isProtected Boolean
    (boolean) - Whether the branch is protected
    sourceBranch String
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    sourceBranchLsn String
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    sourceBranchTime String
    (string) - The point in time on the source branch from which this branch was created
    default boolean
    (boolean) - Whether the branch is the project's default branch
    isProtected boolean
    (boolean) - Whether the branch is protected
    sourceBranch string
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    sourceBranchLsn string
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    sourceBranchTime string
    (string) - The point in time on the source branch from which this branch was created
    default bool
    (boolean) - Whether the branch is the project's default branch
    is_protected bool
    (boolean) - Whether the branch is protected
    source_branch str
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    source_branch_lsn str
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    source_branch_time str
    (string) - The point in time on the source branch from which this branch was created
    default Boolean
    (boolean) - Whether the branch is the project's default branch
    isProtected Boolean
    (boolean) - Whether the branch is protected
    sourceBranch String
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    sourceBranchLsn String
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    sourceBranchTime String
    (string) - The point in time on the source branch from which this branch was created

    PostgresBranchStatus, PostgresBranchStatusArgs

    CurrentState string
    (string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    Default bool
    (boolean) - Whether the branch is the project's default branch
    IsProtected bool
    (boolean) - Whether the branch is protected
    LogicalSizeBytes int
    (integer) - The logical size of the branch
    PendingState string
    (string) - The pending state of the branch, if a state transition is in progress. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    SourceBranch string
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    SourceBranchLsn string
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    SourceBranchTime string
    (string) - The point in time on the source branch from which this branch was created
    StateChangeTime string
    (string) - A timestamp indicating when the current_state began
    CurrentState string
    (string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    Default bool
    (boolean) - Whether the branch is the project's default branch
    IsProtected bool
    (boolean) - Whether the branch is protected
    LogicalSizeBytes int
    (integer) - The logical size of the branch
    PendingState string
    (string) - The pending state of the branch, if a state transition is in progress. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    SourceBranch string
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    SourceBranchLsn string
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    SourceBranchTime string
    (string) - The point in time on the source branch from which this branch was created
    StateChangeTime string
    (string) - A timestamp indicating when the current_state began
    currentState String
    (string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    default_ Boolean
    (boolean) - Whether the branch is the project's default branch
    isProtected Boolean
    (boolean) - Whether the branch is protected
    logicalSizeBytes Integer
    (integer) - The logical size of the branch
    pendingState String
    (string) - The pending state of the branch, if a state transition is in progress. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    sourceBranch String
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    sourceBranchLsn String
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    sourceBranchTime String
    (string) - The point in time on the source branch from which this branch was created
    stateChangeTime String
    (string) - A timestamp indicating when the current_state began
    currentState string
    (string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    default boolean
    (boolean) - Whether the branch is the project's default branch
    isProtected boolean
    (boolean) - Whether the branch is protected
    logicalSizeBytes number
    (integer) - The logical size of the branch
    pendingState string
    (string) - The pending state of the branch, if a state transition is in progress. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    sourceBranch string
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    sourceBranchLsn string
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    sourceBranchTime string
    (string) - The point in time on the source branch from which this branch was created
    stateChangeTime string
    (string) - A timestamp indicating when the current_state began
    current_state str
    (string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    default bool
    (boolean) - Whether the branch is the project's default branch
    is_protected bool
    (boolean) - Whether the branch is protected
    logical_size_bytes int
    (integer) - The logical size of the branch
    pending_state str
    (string) - The pending state of the branch, if a state transition is in progress. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    source_branch str
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    source_branch_lsn str
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    source_branch_time str
    (string) - The point in time on the source branch from which this branch was created
    state_change_time str
    (string) - A timestamp indicating when the current_state began
    currentState String
    (string) - The branch's state, indicating if it is initializing, ready for use, or archived. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    default Boolean
    (boolean) - Whether the branch is the project's default branch
    isProtected Boolean
    (boolean) - Whether the branch is protected
    logicalSizeBytes Number
    (integer) - The logical size of the branch
    pendingState String
    (string) - The pending state of the branch, if a state transition is in progress. Possible values are: ARCHIVED, IMPORTING, INIT, READY, RESETTING
    sourceBranch String
    (string) - The name of the source branch from which this branch was created. Format: projects/{project_id}/branches/{branch_id}
    sourceBranchLsn String
    (string) - The Log Sequence Number (LSN) on the source branch from which this branch was created
    sourceBranchTime String
    (string) - The point in time on the source branch from which this branch was created
    stateChangeTime String
    (string) - A timestamp indicating when the current_state began

    Import

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

    hcl

    import {

    id = “name”

    to = databricks_postgres_branch.this

    }

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

    $ pulumi import databricks:index/postgresBranch:PostgresBranch 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.82.0 published on Friday, Jan 16, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-databricks
      Meet Neo: Your AI Platform Teammate