1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getPostgresBranchRole
planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getPostgresBranchRole

planetscale logo
planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    PostgresBranchRole DataSource

    Example Usage

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

const myPostgresbranchrole = planetscale.getPostgresBranchRole({
    branch: "...my_branch...",
    database: "...my_database...",
    id: "...my_id...",
    organization: "...my_organization...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_postgresbranchrole = planetscale.get_postgres_branch_role(branch="...my_branch...",
    database="...my_database...",
    id="...my_id...",
    organization="...my_organization...")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := planetscale.LookupPostgresBranchRole(ctx, &planetscale.LookupPostgresBranchRoleArgs{
			Branch:       "...my_branch...",
			Database:     "...my_database...",
			Id:           "...my_id...",
			Organization: "...my_organization...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Planetscale = Pulumi.Planetscale;

return await Deployment.RunAsync(() => 
{
    var myPostgresbranchrole = Planetscale.GetPostgresBranchRole.Invoke(new()
    {
        Branch = "...my_branch...",
        Database = "...my_database...",
        Id = "...my_id...",
        Organization = "...my_organization...",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetPostgresBranchRoleArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var myPostgresbranchrole = PlanetscaleFunctions.getPostgresBranchRole(GetPostgresBranchRoleArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .id("...my_id...")
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myPostgresbranchrole:
    fn::invoke:
      function: planetscale:getPostgresBranchRole
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        id: '...my_id...'
        organization: '...my_organization...'

    Using getPostgresBranchRole

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPostgresBranchRole(args: GetPostgresBranchRoleArgs, opts?: InvokeOptions): Promise<GetPostgresBranchRoleResult>
function getPostgresBranchRoleOutput(args: GetPostgresBranchRoleOutputArgs, opts?: InvokeOptions): Output<GetPostgresBranchRoleResult>
    def get_postgres_branch_role(branch: Optional[str] = None,
                             database: Optional[str] = None,
                             id: Optional[str] = None,
                             organization: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetPostgresBranchRoleResult
def get_postgres_branch_role_output(branch: Optional[pulumi.Input[str]] = None,
                             database: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             organization: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetPostgresBranchRoleResult]
    func LookupPostgresBranchRole(ctx *Context, args *LookupPostgresBranchRoleArgs, opts ...InvokeOption) (*LookupPostgresBranchRoleResult, error)
func LookupPostgresBranchRoleOutput(ctx *Context, args *LookupPostgresBranchRoleOutputArgs, opts ...InvokeOption) LookupPostgresBranchRoleResultOutput

    > Note: This function is named LookupPostgresBranchRole in the Go SDK.

    public static class GetPostgresBranchRole 
{
    public static Task<GetPostgresBranchRoleResult> InvokeAsync(GetPostgresBranchRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetPostgresBranchRoleResult> Invoke(GetPostgresBranchRoleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPostgresBranchRoleResult> getPostgresBranchRole(GetPostgresBranchRoleArgs args, InvokeOptions options)
public static Output<GetPostgresBranchRoleResult> getPostgresBranchRole(GetPostgresBranchRoleArgs args, InvokeOptions options)

    fn::invoke:
  function: planetscale:index/getPostgresBranchRole:getPostgresBranchRole
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Branch string
    The name of the branch that owns this resource
    Database string
    The name of the database that owns this resource
    Id string
    The ID of the role
    Organization string
    The name of the organization that owns this resource
    Branch string
    The name of the branch that owns this resource
    Database string
    The name of the database that owns this resource
    Id string
    The ID of the role
    Organization string
    The name of the organization that owns this resource
    branch String
    The name of the branch that owns this resource
    database String
    The name of the database that owns this resource
    id String
    The ID of the role
    organization String
    The name of the organization that owns this resource
    branch string
    The name of the branch that owns this resource
    database string
    The name of the database that owns this resource
    id string
    The ID of the role
    organization string
    The name of the organization that owns this resource
    branch str
    The name of the branch that owns this resource
    database str
    The name of the database that owns this resource
    id str
    The ID of the role
    organization str
    The name of the organization that owns this resource
    branch String
    The name of the branch that owns this resource
    database String
    The name of the database that owns this resource
    id String
    The ID of the role
    organization String
    The name of the organization that owns this resource

    getPostgresBranchRole Result

    The following output properties are available:

    AccessHostUrl string
    The database connection string
    ActorData GetPostgresBranchRoleActorData
    Branch string
    The name of the branch that owns this resource
    BranchData GetPostgresBranchRoleBranchData
    CreatedAt string
    When the role was created
    Database string
    The name of the database that owns this resource
    DatabaseName string
    The database name
    Default bool
    Whether the role is the default postgres user
    DeletedAt string
    When the role was deleted
    DisabledAt string
    When the role was disabled
    DropFailed string
    Error message available when dropping the role fails
    DroppedAt string
    When the role was dropped
    Expired bool
    True if the credentials are expired
    ExpiresAt string
    When the role expires
    Id string
    The ID of the role
    InheritedRoles List<string>
    Database roles these credentials inherit
    Name string
    The name of the role
    Organization string
    The name of the organization that owns this resource
    PrivateAccessHostUrl string
    The database connection string for private connections
    PrivateConnectionServiceName string
    The service name to set up private connectivity
    Ttl double
    Number of seconds before the credentials expire
    UpdatedAt string
    When the role was updated
    Username string
    The database user name
    AccessHostUrl string
    The database connection string
    ActorData GetPostgresBranchRoleActorData
    Branch string
    The name of the branch that owns this resource
    BranchData GetPostgresBranchRoleBranchData
    CreatedAt string
    When the role was created
    Database string
    The name of the database that owns this resource
    DatabaseName string
    The database name
    Default bool
    Whether the role is the default postgres user
    DeletedAt string
    When the role was deleted
    DisabledAt string
    When the role was disabled
    DropFailed string
    Error message available when dropping the role fails
    DroppedAt string
    When the role was dropped
    Expired bool
    True if the credentials are expired
    ExpiresAt string
    When the role expires
    Id string
    The ID of the role
    InheritedRoles []string
    Database roles these credentials inherit
    Name string
    The name of the role
    Organization string
    The name of the organization that owns this resource
    PrivateAccessHostUrl string
    The database connection string for private connections
    PrivateConnectionServiceName string
    The service name to set up private connectivity
    Ttl float64
    Number of seconds before the credentials expire
    UpdatedAt string
    When the role was updated
    Username string
    The database user name
    accessHostUrl String
    The database connection string
    actorData GetPostgresBranchRoleActorData
    branch String
    The name of the branch that owns this resource
    branchData GetPostgresBranchRoleBranchData
    createdAt String
    When the role was created
    database String
    The name of the database that owns this resource
    databaseName String
    The database name
    default_ Boolean
    Whether the role is the default postgres user
    deletedAt String
    When the role was deleted
    disabledAt String
    When the role was disabled
    dropFailed String
    Error message available when dropping the role fails
    droppedAt String
    When the role was dropped
    expired Boolean
    True if the credentials are expired
    expiresAt String
    When the role expires
    id String
    The ID of the role
    inheritedRoles List<String>
    Database roles these credentials inherit
    name String
    The name of the role
    organization String
    The name of the organization that owns this resource
    privateAccessHostUrl String
    The database connection string for private connections
    privateConnectionServiceName String
    The service name to set up private connectivity
    ttl Double
    Number of seconds before the credentials expire
    updatedAt String
    When the role was updated
    username String
    The database user name
    accessHostUrl string
    The database connection string
    actorData GetPostgresBranchRoleActorData
    branch string
    The name of the branch that owns this resource
    branchData GetPostgresBranchRoleBranchData
    createdAt string
    When the role was created
    database string
    The name of the database that owns this resource
    databaseName string
    The database name
    default boolean
    Whether the role is the default postgres user
    deletedAt string
    When the role was deleted
    disabledAt string
    When the role was disabled
    dropFailed string
    Error message available when dropping the role fails
    droppedAt string
    When the role was dropped
    expired boolean
    True if the credentials are expired
    expiresAt string
    When the role expires
    id string
    The ID of the role
    inheritedRoles string[]
    Database roles these credentials inherit
    name string
    The name of the role
    organization string
    The name of the organization that owns this resource
    privateAccessHostUrl string
    The database connection string for private connections
    privateConnectionServiceName string
    The service name to set up private connectivity
    ttl number
    Number of seconds before the credentials expire
    updatedAt string
    When the role was updated
    username string
    The database user name
    access_host_url str
    The database connection string
    actor_data GetPostgresBranchRoleActorData
    branch str
    The name of the branch that owns this resource
    branch_data GetPostgresBranchRoleBranchData
    created_at str
    When the role was created
    database str
    The name of the database that owns this resource
    database_name str
    The database name
    default bool
    Whether the role is the default postgres user
    deleted_at str
    When the role was deleted
    disabled_at str
    When the role was disabled
    drop_failed str
    Error message available when dropping the role fails
    dropped_at str
    When the role was dropped
    expired bool
    True if the credentials are expired
    expires_at str
    When the role expires
    id str
    The ID of the role
    inherited_roles Sequence[str]
    Database roles these credentials inherit
    name str
    The name of the role
    organization str
    The name of the organization that owns this resource
    private_access_host_url str
    The database connection string for private connections
    private_connection_service_name str
    The service name to set up private connectivity
    ttl float
    Number of seconds before the credentials expire
    updated_at str
    When the role was updated
    username str
    The database user name
    accessHostUrl String
    The database connection string
    actorData Property Map
    branch String
    The name of the branch that owns this resource
    branchData Property Map
    createdAt String
    When the role was created
    database String
    The name of the database that owns this resource
    databaseName String
    The database name
    default Boolean
    Whether the role is the default postgres user
    deletedAt String
    When the role was deleted
    disabledAt String
    When the role was disabled
    dropFailed String
    Error message available when dropping the role fails
    droppedAt String
    When the role was dropped
    expired Boolean
    True if the credentials are expired
    expiresAt String
    When the role expires
    id String
    The ID of the role
    inheritedRoles List<String>
    Database roles these credentials inherit
    name String
    The name of the role
    organization String
    The name of the organization that owns this resource
    privateAccessHostUrl String
    The database connection string for private connections
    privateConnectionServiceName String
    The service name to set up private connectivity
    ttl Number
    Number of seconds before the credentials expire
    updatedAt String
    When the role was updated
    username String
    The database user name

    Supporting Types

    GetPostgresBranchRoleActorData

    AvatarUrl string
    The URL of the actor's avatar
    DisplayName string
    The name of the actor
    Id string
    The ID of the actor
    AvatarUrl string
    The URL of the actor's avatar
    DisplayName string
    The name of the actor
    Id string
    The ID of the actor
    avatarUrl String
    The URL of the actor's avatar
    displayName String
    The name of the actor
    id String
    The ID of the actor
    avatarUrl string
    The URL of the actor's avatar
    displayName string
    The name of the actor
    id string
    The ID of the actor
    avatar_url str
    The URL of the actor's avatar
    display_name str
    The name of the actor
    id str
    The ID of the actor
    avatarUrl String
    The URL of the actor's avatar
    displayName String
    The name of the actor
    id String
    The ID of the actor

    GetPostgresBranchRoleBranchData

    DeletedAt string
    When the resource was deleted, if deleted
    Id string
    The ID for the resource
    Name string
    The name for the resource
    DeletedAt string
    When the resource was deleted, if deleted
    Id string
    The ID for the resource
    Name string
    The name for the resource
    deletedAt String
    When the resource was deleted, if deleted
    id String
    The ID for the resource
    name String
    The name for the resource
    deletedAt string
    When the resource was deleted, if deleted
    id string
    The ID for the resource
    name string
    The name for the resource
    deleted_at str
    When the resource was deleted, if deleted
    id str
    The ID for the resource
    name str
    The name for the resource
    deletedAt String
    When the resource was deleted, if deleted
    id String
    The ID for the resource
    name String
    The name for the resource

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    planetscale 1.0.0-rc1 published on Friday, Jan 30, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale
      Meet Neo: Your AI Platform Teammate