planetscale.getPostgresBranchRole

planetscale 1.0.0, Mar 2 26

Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale

planetscale/terraform-provider-planetscale

Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale

planetscale/terraform-provider-planetscale

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: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Id string: The ID of the role
Organization string: Organization name slug from list_organizations. Example: acme.

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Id string: The ID of the role
Organization string: Organization name slug from list_organizations. Example: acme.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
id String: The ID of the role
organization String: Organization name slug from list_organizations. Example: acme.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
id string: The ID of the role
organization string: Organization name slug from list_organizations. Example: acme.

branch str: Branch name from list_branches. Example: main.
database str: Database name slug from list_databases. Example: app-db.
id str: The ID of the role
organization str: Organization name slug from list_organizations. Example: acme.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
id String: The ID of the role
organization String: Organization name slug from list_organizations. Example: acme.

getPostgresBranchRole Result

The following output properties are available:

AccessHostUrl string: The database connection string
ActorData GetPostgresBranchRoleActorData
Branch string: Branch name from list_branches. Example: main.
BranchData GetPostgresBranchRoleBranchData
CreatedAt string: When the role was created
Database string: Database name slug from list_databases. Example: app-db.
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: Organization name slug from list_organizations. Example: acme.
PrivateAccessHostUrl string: The database connection string for private connections
PrivateConnectionServiceName string: The service name to set up private connectivity
QuerySafetySettings GetPostgresBranchRoleQuerySafetySettings
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: Branch name from list_branches. Example: main.
BranchData GetPostgresBranchRoleBranchData
CreatedAt string: When the role was created
Database string: Database name slug from list_databases. Example: app-db.
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: Organization name slug from list_organizations. Example: acme.
PrivateAccessHostUrl string: The database connection string for private connections
PrivateConnectionServiceName string: The service name to set up private connectivity
QuerySafetySettings GetPostgresBranchRoleQuerySafetySettings
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: Branch name from list_branches. Example: main.
branchData GetPostgresBranchRoleBranchData
createdAt String: When the role was created
database String: Database name slug from list_databases. Example: app-db.
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: Organization name slug from list_organizations. Example: acme.
privateAccessHostUrl String: The database connection string for private connections
privateConnectionServiceName String: The service name to set up private connectivity
querySafetySettings GetPostgresBranchRoleQuerySafetySettings
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: Branch name from list_branches. Example: main.
branchData GetPostgresBranchRoleBranchData
createdAt string: When the role was created
database string: Database name slug from list_databases. Example: app-db.
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: Organization name slug from list_organizations. Example: acme.
privateAccessHostUrl string: The database connection string for private connections
privateConnectionServiceName string: The service name to set up private connectivity
querySafetySettings GetPostgresBranchRoleQuerySafetySettings
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: Branch name from list_branches. Example: main.
branch_data GetPostgresBranchRoleBranchData
created_at str: When the role was created
database str: Database name slug from list_databases. Example: app-db.
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: Organization name slug from list_organizations. Example: acme.
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
query_safety_settings GetPostgresBranchRoleQuerySafetySettings
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: Branch name from list_branches. Example: main.
branchData Property Map
createdAt String: When the role was created
database String: Database name slug from list_databases. Example: app-db.
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: Organization name slug from list_organizations. Example: acme.
privateAccessHostUrl String: The database connection string for private connections
privateConnectionServiceName String: The service name to set up private connectivity
querySafetySettings Property Map
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

GetPostgresBranchRoleQuerySafetySettings

RequireWhereOnDelete string: Require WHERE clause on DELETE statements
RequireWhereOnUpdate string: Require WHERE clause on UPDATE statements

RequireWhereOnDelete string: Require WHERE clause on DELETE statements
RequireWhereOnUpdate string: Require WHERE clause on UPDATE statements

requireWhereOnDelete String: Require WHERE clause on DELETE statements
requireWhereOnUpdate String: Require WHERE clause on UPDATE statements

requireWhereOnDelete string: Require WHERE clause on DELETE statements
requireWhereOnUpdate string: Require WHERE clause on UPDATE statements

require_where_on_delete str: Require WHERE clause on DELETE statements
require_where_on_update str: Require WHERE clause on UPDATE statements

requireWhereOnDelete String: Require WHERE clause on DELETE statements
requireWhereOnUpdate String: Require WHERE clause on UPDATE statements

Package Details

Repository: planetscale planetscale/terraform-provider-planetscale
License
Notes: This Pulumi package is based on the planetscale Terraform Provider.

Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale

Schema (JSON)

planetscale/terraform-provider-planetscale

planetscale.getPostgresBranchRole

On this page

On this page

Example Usage

Using getPostgresBranchRole

getPostgresBranchRole Result

Supporting Types

GetPostgresBranchRoleActorData

GetPostgresBranchRoleBranchData

GetPostgresBranchRoleQuerySafetySettings

Package Details

On this page

On this page