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

planetscale.VitessBranchPassword

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

    VitessBranchPassword Resource

    Example Usage

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

const myVitessbranchpassword = new planetscale.VitessBranchPassword("my_vitessbranchpassword", {
    organization: "my-organization",
    database: "ru00w3vqvfr9",
    branch: "2474dzfubrf3",
    role: "admin",
});

    import pulumi
import pulumi_planetscale as planetscale

my_vitessbranchpassword = planetscale.VitessBranchPassword("my_vitessbranchpassword",
    organization="my-organization",
    database="ru00w3vqvfr9",
    branch="2474dzfubrf3",
    role="admin")

    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.NewVitessBranchPassword(ctx, "my_vitessbranchpassword", &planetscale.VitessBranchPasswordArgs{
			Organization: pulumi.String("my-organization"),
			Database:     pulumi.String("ru00w3vqvfr9"),
			Branch:       pulumi.String("2474dzfubrf3"),
			Role:         pulumi.String("admin"),
		})
		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 = new Planetscale.VitessBranchPassword("my_vitessbranchpassword", new()
    {
        Organization = "my-organization",
        Database = "ru00w3vqvfr9",
        Branch = "2474dzfubrf3",
        Role = "admin",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.VitessBranchPassword;
import com.pulumi.planetscale.VitessBranchPasswordArgs;
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) {
        var myVitessbranchpassword = new VitessBranchPassword("myVitessbranchpassword", VitessBranchPasswordArgs.builder()
            .organization("my-organization")
            .database("ru00w3vqvfr9")
            .branch("2474dzfubrf3")
            .role("admin")
            .build());

    }
}

    resources:
  myVitessbranchpassword:
    type: planetscale:VitessBranchPassword
    name: my_vitessbranchpassword
    properties:
      organization: my-organization
      database: ru00w3vqvfr9
      branch: 2474dzfubrf3
      role: admin

    Create VitessBranchPassword Resource

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

    Constructor syntax

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

@overload
def VitessBranchPassword(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         branch: Optional[str] = None,
                         database: Optional[str] = None,
                         organization: Optional[str] = None,
                         cidrs: Optional[Sequence[str]] = None,
                         direct_vtgate: Optional[bool] = None,
                         name: Optional[str] = None,
                         replica: Optional[bool] = None,
                         role: Optional[str] = None,
                         ttl: Optional[float] = None)
    func NewVitessBranchPassword(ctx *Context, name string, args VitessBranchPasswordArgs, opts ...ResourceOption) (*VitessBranchPassword, error)
    public VitessBranchPassword(string name, VitessBranchPasswordArgs args, CustomResourceOptions? opts = null)
    public VitessBranchPassword(String name, VitessBranchPasswordArgs args)
public VitessBranchPassword(String name, VitessBranchPasswordArgs args, CustomResourceOptions options)

    type: planetscale:VitessBranchPassword
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 VitessBranchPasswordArgs
    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 VitessBranchPasswordArgs
    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 VitessBranchPasswordArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VitessBranchPasswordArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VitessBranchPasswordArgs
    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 vitessBranchPasswordResource = new Planetscale.VitessBranchPassword("vitessBranchPasswordResource", new()
{
    Branch = "string",
    Database = "string",
    Organization = "string",
    Cidrs = new[]
    {
        "string",
    },
    DirectVtgate = false,
    Name = "string",
    Replica = false,
    Role = "string",
    Ttl = 0,
});

    example, err := planetscale.NewVitessBranchPassword(ctx, "vitessBranchPasswordResource", &planetscale.VitessBranchPasswordArgs{
	Branch:       pulumi.String("string"),
	Database:     pulumi.String("string"),
	Organization: pulumi.String("string"),
	Cidrs: pulumi.StringArray{
		pulumi.String("string"),
	},
	DirectVtgate: pulumi.Bool(false),
	Name:         pulumi.String("string"),
	Replica:      pulumi.Bool(false),
	Role:         pulumi.String("string"),
	Ttl:          pulumi.Float64(0),
})

    var vitessBranchPasswordResource = new VitessBranchPassword("vitessBranchPasswordResource", VitessBranchPasswordArgs.builder()
    .branch("string")
    .database("string")
    .organization("string")
    .cidrs("string")
    .directVtgate(false)
    .name("string")
    .replica(false)
    .role("string")
    .ttl(0.0)
    .build());

    vitess_branch_password_resource = planetscale.VitessBranchPassword("vitessBranchPasswordResource",
    branch="string",
    database="string",
    organization="string",
    cidrs=["string"],
    direct_vtgate=False,
    name="string",
    replica=False,
    role="string",
    ttl=0)

    const vitessBranchPasswordResource = new planetscale.VitessBranchPassword("vitessBranchPasswordResource", {
    branch: "string",
    database: "string",
    organization: "string",
    cidrs: ["string"],
    directVtgate: false,
    name: "string",
    replica: false,
    role: "string",
    ttl: 0,
});

    type: planetscale:VitessBranchPassword
properties:
    branch: string
    cidrs:
        - string
    database: string
    directVtgate: false
    name: string
    organization: string
    replica: false
    role: string
    ttl: 0

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

    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
    Cidrs List<string>
    List of IP addresses or CIDR ranges that can use this password
    DirectVtgate bool
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    Name string
    Optional name of the password
    Replica bool
    Whether the password is for a read replica. Requires replacement if changed.
    Role string
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    Ttl double
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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
    Cidrs []string
    List of IP addresses or CIDR ranges that can use this password
    DirectVtgate bool
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    Name string
    Optional name of the password
    Replica bool
    Whether the password is for a read replica. Requires replacement if changed.
    Role string
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    Ttl float64
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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
    cidrs List<String>
    List of IP addresses or CIDR ranges that can use this password
    directVtgate Boolean
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    name String
    Optional name of the password
    replica Boolean
    Whether the password is for a read replica. Requires replacement if changed.
    role String
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl Double
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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
    cidrs string[]
    List of IP addresses or CIDR ranges that can use this password
    directVtgate boolean
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    name string
    Optional name of the password
    replica boolean
    Whether the password is for a read replica. Requires replacement if changed.
    role string
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl number
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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
    cidrs Sequence[str]
    List of IP addresses or CIDR ranges that can use this password
    direct_vtgate bool
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    name str
    Optional name of the password
    replica bool
    Whether the password is for a read replica. Requires replacement if changed.
    role str
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl float
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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
    cidrs List<String>
    List of IP addresses or CIDR ranges that can use this password
    directVtgate Boolean
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    name String
    Optional name of the password
    replica Boolean
    Whether the password is for a read replica. Requires replacement if changed.
    role String
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl Number
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.

    Outputs

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

    AccessHostRegionalUrl string
    The regional host URL
    AccessHostRegionalUrls List<string>
    The read-only replica host URLs
    AccessHostUrl string
    The host URL for the password
    Actor VitessBranchPasswordActor
    CreatedAt string
    When the password was created
    DatabaseBranch VitessBranchPasswordDatabaseBranch
    DeletedAt string
    When the password was deleted
    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 provider-assigned unique ID for this managed resource.
    LastUsedAt string
    When the password was last used to execute a query
    PlainText string
    The plain text password, available only after create
    Region VitessBranchPasswordRegion
    Renewable bool
    Whether or not the password can be renewed
    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 VitessBranchPasswordActor
    CreatedAt string
    When the password was created
    DatabaseBranch VitessBranchPasswordDatabaseBranch
    DeletedAt string
    When the password was deleted
    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 provider-assigned unique ID for this managed resource.
    LastUsedAt string
    When the password was last used to execute a query
    PlainText string
    The plain text password, available only after create
    Region VitessBranchPasswordRegion
    Renewable bool
    Whether or not the password can be renewed
    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 VitessBranchPasswordActor
    createdAt String
    When the password was created
    databaseBranch VitessBranchPasswordDatabaseBranch
    deletedAt String
    When the password was deleted
    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 provider-assigned unique ID for this managed resource.
    lastUsedAt String
    When the password was last used to execute a query
    plainText String
    The plain text password, available only after create
    region VitessBranchPasswordRegion
    renewable Boolean
    Whether or not the password can be renewed
    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 VitessBranchPasswordActor
    createdAt string
    When the password was created
    databaseBranch VitessBranchPasswordDatabaseBranch
    deletedAt string
    When the password was deleted
    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 provider-assigned unique ID for this managed resource.
    lastUsedAt string
    When the password was last used to execute a query
    plainText string
    The plain text password, available only after create
    region VitessBranchPasswordRegion
    renewable boolean
    Whether or not the password can be renewed
    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 VitessBranchPasswordActor
    created_at str
    When the password was created
    database_branch VitessBranchPasswordDatabaseBranch
    deleted_at str
    When the password was deleted
    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 provider-assigned unique ID for this managed resource.
    last_used_at str
    When the password was last used to execute a query
    plain_text str
    The plain text password, available only after create
    region VitessBranchPasswordRegion
    renewable bool
    Whether or not the password can be renewed
    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
    createdAt String
    When the password was created
    databaseBranch Property Map
    deletedAt String
    When the password was deleted
    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 provider-assigned unique ID for this managed resource.
    lastUsedAt String
    When the password was last used to execute a query
    plainText String
    The plain text password, available only after create
    region Property Map
    renewable Boolean
    Whether or not the password can be renewed
    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

    Look up Existing VitessBranchPassword Resource

    Get an existing VitessBranchPassword 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?: VitessBranchPasswordState, opts?: CustomResourceOptions): VitessBranchPassword
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_host_regional_url: Optional[str] = None,
        access_host_regional_urls: Optional[Sequence[str]] = None,
        access_host_url: Optional[str] = None,
        actor: Optional[VitessBranchPasswordActorArgs] = None,
        branch: Optional[str] = None,
        cidrs: Optional[Sequence[str]] = None,
        created_at: Optional[str] = None,
        database: Optional[str] = None,
        database_branch: Optional[VitessBranchPasswordDatabaseBranchArgs] = None,
        deleted_at: Optional[str] = None,
        direct_vtgate: Optional[bool] = None,
        direct_vtgate_addresses: Optional[Sequence[str]] = None,
        expired: Optional[bool] = None,
        expires_at: Optional[str] = None,
        last_used_at: Optional[str] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        plain_text: Optional[str] = None,
        region: Optional[VitessBranchPasswordRegionArgs] = None,
        renewable: Optional[bool] = None,
        replica: Optional[bool] = None,
        role: Optional[str] = None,
        ttl: Optional[float] = None,
        ttl_seconds: Optional[float] = None,
        username: Optional[str] = None) -> VitessBranchPassword
    func GetVitessBranchPassword(ctx *Context, name string, id IDInput, state *VitessBranchPasswordState, opts ...ResourceOption) (*VitessBranchPassword, error)
    public static VitessBranchPassword Get(string name, Input<string> id, VitessBranchPasswordState? state, CustomResourceOptions? opts = null)
    public static VitessBranchPassword get(String name, Output<String> id, VitessBranchPasswordState state, CustomResourceOptions options)
    resources:  _:    type: planetscale:VitessBranchPassword    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:
    AccessHostRegionalUrl string
    The regional host URL
    AccessHostRegionalUrls List<string>
    The read-only replica host URLs
    AccessHostUrl string
    The host URL for the password
    Actor VitessBranchPasswordActor
    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 VitessBranchPasswordDatabaseBranch
    DeletedAt string
    When the password was deleted
    DirectVtgate bool
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    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
    LastUsedAt string
    When the password was last used to execute a query
    Name string
    Optional name of the password
    Organization string
    The name of the organization the password belongs to
    PlainText string
    The plain text password, available only after create
    Region VitessBranchPasswordRegion
    Renewable bool
    Whether or not the password can be renewed
    Replica bool
    Whether the password is for a read replica. Requires replacement if changed.
    Role string
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    Ttl double
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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 VitessBranchPasswordActorArgs
    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 VitessBranchPasswordDatabaseBranchArgs
    DeletedAt string
    When the password was deleted
    DirectVtgate bool
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    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
    LastUsedAt string
    When the password was last used to execute a query
    Name string
    Optional name of the password
    Organization string
    The name of the organization the password belongs to
    PlainText string
    The plain text password, available only after create
    Region VitessBranchPasswordRegionArgs
    Renewable bool
    Whether or not the password can be renewed
    Replica bool
    Whether the password is for a read replica. Requires replacement if changed.
    Role string
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    Ttl float64
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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 VitessBranchPasswordActor
    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 VitessBranchPasswordDatabaseBranch
    deletedAt String
    When the password was deleted
    directVtgate Boolean
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    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
    lastUsedAt String
    When the password was last used to execute a query
    name String
    Optional name of the password
    organization String
    The name of the organization the password belongs to
    plainText String
    The plain text password, available only after create
    region VitessBranchPasswordRegion
    renewable Boolean
    Whether or not the password can be renewed
    replica Boolean
    Whether the password is for a read replica. Requires replacement if changed.
    role String
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl Double
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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 VitessBranchPasswordActor
    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 VitessBranchPasswordDatabaseBranch
    deletedAt string
    When the password was deleted
    directVtgate boolean
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    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
    lastUsedAt string
    When the password was last used to execute a query
    name string
    Optional name of the password
    organization string
    The name of the organization the password belongs to
    plainText string
    The plain text password, available only after create
    region VitessBranchPasswordRegion
    renewable boolean
    Whether or not the password can be renewed
    replica boolean
    Whether the password is for a read replica. Requires replacement if changed.
    role string
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl number
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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 VitessBranchPasswordActorArgs
    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 VitessBranchPasswordDatabaseBranchArgs
    deleted_at str
    When the password was deleted
    direct_vtgate bool
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    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
    last_used_at str
    When the password was last used to execute a query
    name str
    Optional name of the password
    organization str
    The name of the organization the password belongs to
    plain_text str
    The plain text password, available only after create
    region VitessBranchPasswordRegionArgs
    renewable bool
    Whether or not the password can be renewed
    replica bool
    Whether the password is for a read replica. Requires replacement if changed.
    role str
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl float
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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
    Whether the password connects directly to a VTGate. Requires replacement if changed.
    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
    lastUsedAt String
    When the password was last used to execute a query
    name String
    Optional name of the password
    organization String
    The name of the organization the password belongs to
    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 the password is for a read replica. Requires replacement if changed.
    role String
    The database role of the password (i.e. admin). must be one of ["reader", "writer", "admin", "readwriter"]; Requires replacement if changed.
    ttl Number
    Time to live (in seconds) for the password. The password will be invalid when TTL has passed. Requires replacement if changed.
    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

    VitessBranchPasswordActor, VitessBranchPasswordActorArgs

    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

    VitessBranchPasswordDatabaseBranch, VitessBranchPasswordDatabaseBranchArgs

    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

    VitessBranchPasswordRegion, VitessBranchPasswordRegionArgs

    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

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = planetscale_vitess_branch_password.my_planetscale_vitess_branch_password

    id = jsonencode({

    branch = "..."

database = "..."

id = "..."

organization = "..."

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import planetscale:index/vitessBranchPassword:VitessBranchPassword my_planetscale_vitess_branch_password '{"branch": "...", "database": "...", "id": "...", "organization": "..."}'

    To learn more about importing existing cloud resources, see Importing resources.

    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