planetscale.getVitessBranchPassword

planetscale 1.0.0, Mar 2 26

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

Schema (JSON)

planetscale/terraform-provider-planetscale

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

Schema (JSON)

planetscale/terraform-provider-planetscale

Example Usage

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

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

import pulumi
import pulumi_planetscale as planetscale

my_vitessbranchpassword = planetscale.get_vitess_branch_password(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.LookupVitessBranchPassword(ctx, &planetscale.LookupVitessBranchPasswordArgs{
			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 myVitessbranchpassword = Planetscale.GetVitessBranchPassword.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.GetVitessBranchPasswordArgs;
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 myVitessbranchpassword = PlanetscaleFunctions.getVitessBranchPassword(GetVitessBranchPasswordArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .id("...my_id...")
            .organization("...my_organization...")
            .build());

    }
}

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

Using getVitessBranchPassword

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 getVitessBranchPassword(args: GetVitessBranchPasswordArgs, opts?: InvokeOptions): Promise<GetVitessBranchPasswordResult>
function getVitessBranchPasswordOutput(args: GetVitessBranchPasswordOutputArgs, opts?: InvokeOptions): Output<GetVitessBranchPasswordResult>

def get_vitess_branch_password(branch: Optional[str] = None,
                               database: Optional[str] = None,
                               id: Optional[str] = None,
                               organization: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetVitessBranchPasswordResult
def get_vitess_branch_password_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[GetVitessBranchPasswordResult]

func LookupVitessBranchPassword(ctx *Context, args *LookupVitessBranchPasswordArgs, opts ...InvokeOption) (*LookupVitessBranchPasswordResult, error)
func LookupVitessBranchPasswordOutput(ctx *Context, args *LookupVitessBranchPasswordOutputArgs, opts ...InvokeOption) LookupVitessBranchPasswordResultOutput

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

public static class GetVitessBranchPassword 
{
    public static Task<GetVitessBranchPasswordResult> InvokeAsync(GetVitessBranchPasswordArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessBranchPasswordResult> Invoke(GetVitessBranchPasswordInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVitessBranchPasswordResult> getVitessBranchPassword(GetVitessBranchPasswordArgs args, InvokeOptions options)
public static Output<GetVitessBranchPasswordResult> getVitessBranchPassword(GetVitessBranchPasswordArgs args, InvokeOptions options)

fn::invoke:
  function: planetscale:index/getVitessBranchPassword:getVitessBranchPassword
  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
Id string: The ID for the password
Organization string: The name of the organization the password belongs to

Branch string: The name of the branch the password belongs to
Database string: The name of the database the password belongs to
Id string: The ID for the password
Organization string: The name of the organization the password belongs to

branch String: The name of the branch the password belongs to
database String: The name of the database the password belongs to
id String: The ID for the password
organization String: The name of the organization the password belongs to

branch string: The name of the branch the password belongs to
database string: The name of the database the password belongs to
id string: The ID for the password
organization string: The name of the organization the password belongs to

branch str: The name of the branch the password belongs to
database str: The name of the database the password belongs to
id str: The ID for the password
organization str: The name of the organization the password belongs to

branch String: The name of the branch the password belongs to
database String: The name of the database the password belongs to
id String: The ID for the password
organization String: The name of the organization the password belongs to

getVitessBranchPassword Result

The following output properties are available:

AccessHostRegionalUrl string: The regional host URL
AccessHostRegionalUrls List<string>: The read-only replica host URLs
AccessHostUrl string: The host URL for the password
Actor GetVitessBranchPasswordActor
Branch string: The name of the branch the password belongs to
Cidrs List<string>: List of IP addresses or CIDR ranges that can use this password
CreatedAt string: When the password was created
Database string: The name of the database the password belongs to
DatabaseBranch GetVitessBranchPasswordDatabaseBranch
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
Organization string: The name of the organization the password belongs to
Region GetVitessBranchPasswordRegion
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 GetVitessBranchPasswordActor
Branch string: The name of the branch the password belongs to
Cidrs []string: List of IP addresses or CIDR ranges that can use this password
CreatedAt string: When the password was created
Database string: The name of the database the password belongs to
DatabaseBranch GetVitessBranchPasswordDatabaseBranch
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
Organization string: The name of the organization the password belongs to
Region GetVitessBranchPasswordRegion
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 GetVitessBranchPasswordActor
branch String: The name of the branch the password belongs to
cidrs List<String>: List of IP addresses or CIDR ranges that can use this password
createdAt String: When the password was created
database String: The name of the database the password belongs to
databaseBranch GetVitessBranchPasswordDatabaseBranch
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
organization String: The name of the organization the password belongs to
region GetVitessBranchPasswordRegion
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 GetVitessBranchPasswordActor
branch string: The name of the branch the password belongs to
cidrs string[]: List of IP addresses or CIDR ranges that can use this password
createdAt string: When the password was created
database string: The name of the database the password belongs to
databaseBranch GetVitessBranchPasswordDatabaseBranch
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
organization string: The name of the organization the password belongs to
region GetVitessBranchPasswordRegion
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 GetVitessBranchPasswordActor
branch str: The name of the branch the password belongs to
cidrs Sequence[str]: List of IP addresses or CIDR ranges that can use this password
created_at str: When the password was created
database str: The name of the database the password belongs to
database_branch GetVitessBranchPasswordDatabaseBranch
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
organization str: The name of the organization the password belongs to
region GetVitessBranchPasswordRegion
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
branch String: The name of the branch the password belongs to
cidrs List<String>: List of IP addresses or CIDR ranges that can use this password
createdAt String: When the password was created
database String: The name of the database the password belongs to
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
organization String: The name of the organization the password belongs to
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

Supporting Types

GetVitessBranchPasswordActor

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

GetVitessBranchPasswordDatabaseBranch

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

GetVitessBranchPasswordRegion

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