1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getVitessBranchPasswords
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getVitessBranchPasswords

planetscale logo
Viewing docs for planetscale 1.0.0
published on Monday, Mar 2, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    VitessBranchPasswords DataSource

    Example Usage

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

const myVitessbranchpasswords = planetscale.getVitessBranchPasswords({
    branch: "...my_branch...",
    database: "...my_database...",
    organization: "...my_organization...",
    readOnlyRegionId: "...my_read_only_region_id...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_vitessbranchpasswords = planetscale.get_vitess_branch_passwords(branch="...my_branch...",
    database="...my_database...",
    organization="...my_organization...",
    read_only_region_id="...my_read_only_region_id...")

    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.GetVitessBranchPasswords(ctx, &planetscale.GetVitessBranchPasswordsArgs{
			Branch:           "...my_branch...",
			Database:         "...my_database...",
			Organization:     "...my_organization...",
			ReadOnlyRegionId: pulumi.StringRef("...my_read_only_region_id..."),
		}, 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 myVitessbranchpasswords = Planetscale.GetVitessBranchPasswords.Invoke(new()
    {
        Branch = "...my_branch...",
        Database = "...my_database...",
        Organization = "...my_organization...",
        ReadOnlyRegionId = "...my_read_only_region_id...",
    });

});

    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.GetVitessBranchPasswordsArgs;
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 myVitessbranchpasswords = PlanetscaleFunctions.getVitessBranchPasswords(GetVitessBranchPasswordsArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .organization("...my_organization...")
            .readOnlyRegionId("...my_read_only_region_id...")
            .build());

    }
}

    variables:
  myVitessbranchpasswords:
    fn::invoke:
      function: planetscale:getVitessBranchPasswords
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        organization: '...my_organization...'
        readOnlyRegionId: '...my_read_only_region_id...'

    Using getVitessBranchPasswords

    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 getVitessBranchPasswords(args: GetVitessBranchPasswordsArgs, opts?: InvokeOptions): Promise<GetVitessBranchPasswordsResult>
function getVitessBranchPasswordsOutput(args: GetVitessBranchPasswordsOutputArgs, opts?: InvokeOptions): Output<GetVitessBranchPasswordsResult>
    def get_vitess_branch_passwords(branch: Optional[str] = None,
                                database: Optional[str] = None,
                                organization: Optional[str] = None,
                                read_only_region_id: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetVitessBranchPasswordsResult
def get_vitess_branch_passwords_output(branch: Optional[pulumi.Input[str]] = None,
                                database: Optional[pulumi.Input[str]] = None,
                                organization: Optional[pulumi.Input[str]] = None,
                                read_only_region_id: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetVitessBranchPasswordsResult]
    func GetVitessBranchPasswords(ctx *Context, args *GetVitessBranchPasswordsArgs, opts ...InvokeOption) (*GetVitessBranchPasswordsResult, error)
func GetVitessBranchPasswordsOutput(ctx *Context, args *GetVitessBranchPasswordsOutputArgs, opts ...InvokeOption) GetVitessBranchPasswordsResultOutput

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

    public static class GetVitessBranchPasswords 
{
    public static Task<GetVitessBranchPasswordsResult> InvokeAsync(GetVitessBranchPasswordsArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessBranchPasswordsResult> Invoke(GetVitessBranchPasswordsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVitessBranchPasswordsResult> getVitessBranchPasswords(GetVitessBranchPasswordsArgs args, InvokeOptions options)
public static Output<GetVitessBranchPasswordsResult> getVitessBranchPasswords(GetVitessBranchPasswordsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Branch string
    The name of the branch the password belongs to
    Database string
    The name of the database the password belongs to
    Organization string
    The name of the organization the password belongs to
    ReadOnlyRegionId string
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    Branch string
    The name of the branch the password belongs to
    Database string
    The name of the database the password belongs to
    Organization string
    The name of the organization the password belongs to
    ReadOnlyRegionId string
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch String
    The name of the branch the password belongs to
    database String
    The name of the database the password belongs to
    organization String
    The name of the organization the password belongs to
    readOnlyRegionId String
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch string
    The name of the branch the password belongs to
    database string
    The name of the database the password belongs to
    organization string
    The name of the organization the password belongs to
    readOnlyRegionId string
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch str
    The name of the branch the password belongs to
    database str
    The name of the database the password belongs to
    organization str
    The name of the organization the password belongs to
    read_only_region_id str
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch String
    The name of the branch the password belongs to
    database String
    The name of the database the password belongs to
    organization String
    The name of the organization the password belongs to
    readOnlyRegionId String
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region

    getVitessBranchPasswords Result

    The following output properties are available:

    Branch string
    The name of the branch the password belongs to
    Database string
    The name of the database the password belongs to
    Datas List<GetVitessBranchPasswordsData>
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    The name of the organization the password belongs to
    ReadOnlyRegionId string
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    Branch string
    The name of the branch the password belongs to
    Database string
    The name of the database the password belongs to
    Datas []GetVitessBranchPasswordsData
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    The name of the organization the password belongs to
    ReadOnlyRegionId string
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch String
    The name of the branch the password belongs to
    database String
    The name of the database the password belongs to
    datas List<GetVitessBranchPasswordsData>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    The name of the organization the password belongs to
    readOnlyRegionId String
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch string
    The name of the branch the password belongs to
    database string
    The name of the database the password belongs to
    datas GetVitessBranchPasswordsData[]
    id string
    The provider-assigned unique ID for this managed resource.
    organization string
    The name of the organization the password belongs to
    readOnlyRegionId string
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch str
    The name of the branch the password belongs to
    database str
    The name of the database the password belongs to
    datas Sequence[GetVitessBranchPasswordsData]
    id str
    The provider-assigned unique ID for this managed resource.
    organization str
    The name of the organization the password belongs to
    read_only_region_id str
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region
    branch String
    The name of the branch the password belongs to
    database String
    The name of the database the password belongs to
    datas List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    The name of the organization the password belongs to
    readOnlyRegionId String
    A read-only region of the database branch. If present, the password results will be filtered to only those in the region

    Supporting Types

    GetVitessBranchPasswordsData

    AccessHostRegionalUrl string
    The regional host URL
    AccessHostRegionalUrls List<string>
    The read-only replica host URLs
    AccessHostUrl string
    The host URL for the password
    Actor GetVitessBranchPasswordsDataActor
    Cidrs List<string>
    List of IP addresses or CIDR ranges that can use this password
    CreatedAt string
    When the password was created
    DatabaseBranch GetVitessBranchPasswordsDataDatabaseBranch
    DeletedAt string
    When the password was deleted
    DirectVtgate bool
    True if the credentials connect directly to a vtgate, bypassing load balancers
    DirectVtgateAddresses List<string>
    The list of hosts in each availability zone providing direct access to a vtgate
    Expired bool
    True if the credentials are expired
    ExpiresAt string
    When the password will expire
    Id string
    The ID for the password
    LastUsedAt string
    When the password was last used to execute a query
    Name string
    The display name for the password
    PlainText string
    The plain text password, available only after create
    Region GetVitessBranchPasswordsDataRegion
    Renewable bool
    Whether or not the password can be renewed
    Replica bool
    Whether or not the password is for a read replica
    Role string
    The role for the password
    TtlSeconds double
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed
    Username string
    The username for the password
    AccessHostRegionalUrl string
    The regional host URL
    AccessHostRegionalUrls []string
    The read-only replica host URLs
    AccessHostUrl string
    The host URL for the password
    Actor GetVitessBranchPasswordsDataActor
    Cidrs []string
    List of IP addresses or CIDR ranges that can use this password
    CreatedAt string
    When the password was created
    DatabaseBranch GetVitessBranchPasswordsDataDatabaseBranch
    DeletedAt string
    When the password was deleted
    DirectVtgate bool
    True if the credentials connect directly to a vtgate, bypassing load balancers
    DirectVtgateAddresses []string
    The list of hosts in each availability zone providing direct access to a vtgate
    Expired bool
    True if the credentials are expired
    ExpiresAt string
    When the password will expire
    Id string
    The ID for the password
    LastUsedAt string
    When the password was last used to execute a query
    Name string
    The display name for the password
    PlainText string
    The plain text password, available only after create
    Region GetVitessBranchPasswordsDataRegion
    Renewable bool
    Whether or not the password can be renewed
    Replica bool
    Whether or not the password is for a read replica
    Role string
    The role for the password
    TtlSeconds float64
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed
    Username string
    The username for the password
    accessHostRegionalUrl String
    The regional host URL
    accessHostRegionalUrls List<String>
    The read-only replica host URLs
    accessHostUrl String
    The host URL for the password
    actor GetVitessBranchPasswordsDataActor
    cidrs List<String>
    List of IP addresses or CIDR ranges that can use this password
    createdAt String
    When the password was created
    databaseBranch GetVitessBranchPasswordsDataDatabaseBranch
    deletedAt String
    When the password was deleted
    directVtgate Boolean
    True if the credentials connect directly to a vtgate, bypassing load balancers
    directVtgateAddresses List<String>
    The list of hosts in each availability zone providing direct access to a vtgate
    expired Boolean
    True if the credentials are expired
    expiresAt String
    When the password will expire
    id String
    The ID for the password
    lastUsedAt String
    When the password was last used to execute a query
    name String
    The display name for the password
    plainText String
    The plain text password, available only after create
    region GetVitessBranchPasswordsDataRegion
    renewable Boolean
    Whether or not the password can be renewed
    replica Boolean
    Whether or not the password is for a read replica
    role String
    The role for the password
    ttlSeconds Double
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed
    username String
    The username for the password
    accessHostRegionalUrl string
    The regional host URL
    accessHostRegionalUrls string[]
    The read-only replica host URLs
    accessHostUrl string
    The host URL for the password
    actor GetVitessBranchPasswordsDataActor
    cidrs string[]
    List of IP addresses or CIDR ranges that can use this password
    createdAt string
    When the password was created
    databaseBranch GetVitessBranchPasswordsDataDatabaseBranch
    deletedAt string
    When the password was deleted
    directVtgate boolean
    True if the credentials connect directly to a vtgate, bypassing load balancers
    directVtgateAddresses string[]
    The list of hosts in each availability zone providing direct access to a vtgate
    expired boolean
    True if the credentials are expired
    expiresAt string
    When the password will expire
    id string
    The ID for the password
    lastUsedAt string
    When the password was last used to execute a query
    name string
    The display name for the password
    plainText string
    The plain text password, available only after create
    region GetVitessBranchPasswordsDataRegion
    renewable boolean
    Whether or not the password can be renewed
    replica boolean
    Whether or not the password is for a read replica
    role string
    The role for the password
    ttlSeconds number
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed
    username string
    The username for the password
    access_host_regional_url str
    The regional host URL
    access_host_regional_urls Sequence[str]
    The read-only replica host URLs
    access_host_url str
    The host URL for the password
    actor GetVitessBranchPasswordsDataActor
    cidrs Sequence[str]
    List of IP addresses or CIDR ranges that can use this password
    created_at str
    When the password was created
    database_branch GetVitessBranchPasswordsDataDatabaseBranch
    deleted_at str
    When the password was deleted
    direct_vtgate bool
    True if the credentials connect directly to a vtgate, bypassing load balancers
    direct_vtgate_addresses Sequence[str]
    The list of hosts in each availability zone providing direct access to a vtgate
    expired bool
    True if the credentials are expired
    expires_at str
    When the password will expire
    id str
    The ID for the password
    last_used_at str
    When the password was last used to execute a query
    name str
    The display name for the password
    plain_text str
    The plain text password, available only after create
    region GetVitessBranchPasswordsDataRegion
    renewable bool
    Whether or not the password can be renewed
    replica bool
    Whether or not the password is for a read replica
    role str
    The role for the password
    ttl_seconds float
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed
    username str
    The username for the password
    accessHostRegionalUrl String
    The regional host URL
    accessHostRegionalUrls List<String>
    The read-only replica host URLs
    accessHostUrl String
    The host URL for the password
    actor Property Map
    cidrs List<String>
    List of IP addresses or CIDR ranges that can use this password
    createdAt String
    When the password was created
    databaseBranch Property Map
    deletedAt String
    When the password was deleted
    directVtgate Boolean
    True if the credentials connect directly to a vtgate, bypassing load balancers
    directVtgateAddresses List<String>
    The list of hosts in each availability zone providing direct access to a vtgate
    expired Boolean
    True if the credentials are expired
    expiresAt String
    When the password will expire
    id String
    The ID for the password
    lastUsedAt String
    When the password was last used to execute a query
    name String
    The display name for the password
    plainText String
    The plain text password, available only after create
    region Property Map
    renewable Boolean
    Whether or not the password can be renewed
    replica Boolean
    Whether or not the password is for a read replica
    role String
    The role for the password
    ttlSeconds Number
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed
    username String
    The username for the password

    GetVitessBranchPasswordsDataActor

    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

    GetVitessBranchPasswordsDataDatabaseBranch

    Id string
    The ID for the branch
    MysqlEdgeAddress string
    The address of the MySQL provider for the branch
    Name string
    The name for the branch
    PrivateEdgeConnectivity bool
    True if private connectivity is enabled
    Production bool
    Whether or not the branch is a production branch
    Id string
    The ID for the branch
    MysqlEdgeAddress string
    The address of the MySQL provider for the branch
    Name string
    The name for the branch
    PrivateEdgeConnectivity bool
    True if private connectivity is enabled
    Production bool
    Whether or not the branch is a production branch
    id String
    The ID for the branch
    mysqlEdgeAddress String
    The address of the MySQL provider for the branch
    name String
    The name for the branch
    privateEdgeConnectivity Boolean
    True if private connectivity is enabled
    production Boolean
    Whether or not the branch is a production branch
    id string
    The ID for the branch
    mysqlEdgeAddress string
    The address of the MySQL provider for the branch
    name string
    The name for the branch
    privateEdgeConnectivity boolean
    True if private connectivity is enabled
    production boolean
    Whether or not the branch is a production branch
    id str
    The ID for the branch
    mysql_edge_address str
    The address of the MySQL provider for the branch
    name str
    The name for the branch
    private_edge_connectivity bool
    True if private connectivity is enabled
    production bool
    Whether or not the branch is a production branch
    id String
    The ID for the branch
    mysqlEdgeAddress String
    The address of the MySQL provider for the branch
    name String
    The name for the branch
    privateEdgeConnectivity Boolean
    True if private connectivity is enabled
    production Boolean
    Whether or not the branch is a production branch

    GetVitessBranchPasswordsDataRegion

    CurrentDefault bool
    True if the region is the default for new branch creation
    DisplayName string
    Name of the region
    Enabled bool
    Whether or not the region is currently active
    Id string
    The ID of the region
    Location string
    Location of the region
    Provider string
    Provider for the region (ex. AWS)
    PublicIpAddresses List<string>
    Public IP addresses for the region
    Slug string
    The slug of the region
    CurrentDefault bool
    True if the region is the default for new branch creation
    DisplayName string
    Name of the region
    Enabled bool
    Whether or not the region is currently active
    Id string
    The ID of the region
    Location string
    Location of the region
    Provider string
    Provider for the region (ex. AWS)
    PublicIpAddresses []string
    Public IP addresses for the region
    Slug string
    The slug of the region
    currentDefault Boolean
    True if the region is the default for new branch creation
    displayName String
    Name of the region
    enabled Boolean
    Whether or not the region is currently active
    id String
    The ID of the region
    location String
    Location of the region
    provider String
    Provider for the region (ex. AWS)
    publicIpAddresses List<String>
    Public IP addresses for the region
    slug String
    The slug of the region
    currentDefault boolean
    True if the region is the default for new branch creation
    displayName string
    Name of the region
    enabled boolean
    Whether or not the region is currently active
    id string
    The ID of the region
    location string
    Location of the region
    provider string
    Provider for the region (ex. AWS)
    publicIpAddresses string[]
    Public IP addresses for the region
    slug string
    The slug of the region
    current_default bool
    True if the region is the default for new branch creation
    display_name str
    Name of the region
    enabled bool
    Whether or not the region is currently active
    id str
    The ID of the region
    location str
    Location of the region
    provider str
    Provider for the region (ex. AWS)
    public_ip_addresses Sequence[str]
    Public IP addresses for the region
    slug str
    The slug of the region
    currentDefault Boolean
    True if the region is the default for new branch creation
    displayName String
    Name of the region
    enabled Boolean
    Whether or not the region is currently active
    id String
    The ID of the region
    location String
    Location of the region
    provider String
    Provider for the region (ex. AWS)
    publicIpAddresses List<String>
    Public IP addresses for the region
    slug String
    The slug of the region

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    Viewing docs for planetscale 1.0.0
    published on Monday, Mar 2, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale
      Try Pulumi Cloud free. Your team will thank you.