Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getVitessKeyspaces
Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getVitessKeyspaces

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    List PlanetScale Vitess keyspaces on a branch. See planetscale.VitessKeyspace for create, resize, and default-keyspace guidance.

    Example Usage

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

const myVitesskeyspaces = planetscale.getVitessKeyspaces({
    branch: "...my_branch...",
    database: "...my_database...",
    organization: "...my_organization...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_vitesskeyspaces = planetscale.get_vitess_keyspaces(branch="...my_branch...",
    database="...my_database...",
    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.GetVitessKeyspaces(ctx, &planetscale.GetVitessKeyspacesArgs{
			Branch:       "...my_branch...",
			Database:     "...my_database...",
			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 myVitesskeyspaces = Planetscale.GetVitessKeyspaces.Invoke(new()
    {
        Branch = "...my_branch...",
        Database = "...my_database...",
        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.GetVitessKeyspacesArgs;
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 myVitesskeyspaces = PlanetscaleFunctions.getVitessKeyspaces(GetVitessKeyspacesArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myVitesskeyspaces:
    fn::invoke:
      function: planetscale:getVitessKeyspaces
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        organization: '...my_organization...'

    Example coming soon!

    Using getVitessKeyspaces

    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 getVitessKeyspaces(args: GetVitessKeyspacesArgs, opts?: InvokeOptions): Promise<GetVitessKeyspacesResult>
function getVitessKeyspacesOutput(args: GetVitessKeyspacesOutputArgs, opts?: InvokeOutputOptions): Output<GetVitessKeyspacesResult>
    def get_vitess_keyspaces(branch: Optional[str] = None,
                         database: Optional[str] = None,
                         organization: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetVitessKeyspacesResult
def get_vitess_keyspaces_output(branch: pulumi.Input[Optional[str]] = None,
                         database: pulumi.Input[Optional[str]] = None,
                         organization: pulumi.Input[Optional[str]] = None,
                         opts: Optional[InvokeOutputOptions] = None) -> Output[GetVitessKeyspacesResult]
    func GetVitessKeyspaces(ctx *Context, args *GetVitessKeyspacesArgs, opts ...InvokeOption) (*GetVitessKeyspacesResult, error)
func GetVitessKeyspacesOutput(ctx *Context, args *GetVitessKeyspacesOutputArgs, opts ...InvokeOption) GetVitessKeyspacesResultOutput

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

    public static class GetVitessKeyspaces 
{
    public static Task<GetVitessKeyspacesResult> InvokeAsync(GetVitessKeyspacesArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessKeyspacesResult> Invoke(GetVitessKeyspacesInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessKeyspacesResult> Invoke(GetVitessKeyspacesInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetVitessKeyspacesResult> getVitessKeyspaces(GetVitessKeyspacesArgs args, InvokeOptions options)
public static Output<GetVitessKeyspacesResult> getVitessKeyspaces(GetVitessKeyspacesArgs args, InvokeOptions options)
public static Output<GetVitessKeyspacesResult> getVitessKeyspaces(GetVitessKeyspacesArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: planetscale:index/getVitessKeyspaces:getVitessKeyspaces
  arguments:
    # arguments dictionary
    data "planetscale_get_vitess_keyspaces" "name" {
    # arguments
}

    The following arguments are supported:

    Branch string
    The name of the branch
    Database string
    The name of the database the branch belongs to
    Organization string
    The name of the organization the branch belongs to
    Branch string
    The name of the branch
    Database string
    The name of the database the branch belongs to
    Organization string
    The name of the organization the branch belongs to
    branch string
    The name of the branch
    database string
    The name of the database the branch belongs to
    organization string
    The name of the organization the branch belongs to
    branch String
    The name of the branch
    database String
    The name of the database the branch belongs to
    organization String
    The name of the organization the branch belongs to
    branch string
    The name of the branch
    database string
    The name of the database the branch belongs to
    organization string
    The name of the organization the branch belongs to
    branch str
    The name of the branch
    database str
    The name of the database the branch belongs to
    organization str
    The name of the organization the branch belongs to
    branch String
    The name of the branch
    database String
    The name of the database the branch belongs to
    organization String
    The name of the organization the branch belongs to

    getVitessKeyspaces Result

    The following output properties are available:

    Branch string
    The name of the branch
    Database string
    The name of the database the branch belongs to
    Datas List<GetVitessKeyspacesData>
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    The name of the organization the branch belongs to
    Type string
    The response type. Always "list" for paginated responses.
    Branch string
    The name of the branch
    Database string
    The name of the database the branch belongs to
    Datas []GetVitessKeyspacesData
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    The name of the organization the branch belongs to
    Type string
    The response type. Always "list" for paginated responses.
    branch string
    The name of the branch
    database string
    The name of the database the branch belongs to
    datas list(object)
    id string
    The provider-assigned unique ID for this managed resource.
    organization string
    The name of the organization the branch belongs to
    type string
    The response type. Always "list" for paginated responses.
    branch String
    The name of the branch
    database String
    The name of the database the branch belongs to
    datas List<GetVitessKeyspacesData>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    The name of the organization the branch belongs to
    type String
    The response type. Always "list" for paginated responses.
    branch string
    The name of the branch
    database string
    The name of the database the branch belongs to
    datas GetVitessKeyspacesData[]
    id string
    The provider-assigned unique ID for this managed resource.
    organization string
    The name of the organization the branch belongs to
    type string
    The response type. Always "list" for paginated responses.
    branch str
    The name of the branch
    database str
    The name of the database the branch belongs to
    datas Sequence[GetVitessKeyspacesData]
    id str
    The provider-assigned unique ID for this managed resource.
    organization str
    The name of the organization the branch belongs to
    type str
    The response type. Always "list" for paginated responses.
    branch String
    The name of the branch
    database String
    The name of the database the branch 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 branch belongs to
    type String
    The response type. Always "list" for paginated responses.

    Supporting Types

    GetVitessKeyspacesData

    ClusterDisplayName string
    The SKU representing the keyspace cluster size for display
    ClusterSize string
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    ConfigChangeInProgress bool
    Is the keyspace undergoing a config change
    CreatedAt string
    When the keyspace was created
    ExtraReplicas double
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    Id string
    The ID of the keyspace
    Imported bool
    Is this keyspace used in an import
    IsDefault bool
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    Metal bool
    Is the keyspace running on metal instances
    Name string
    Name of the keyspace
    NodeTtlStrategy string
    Controls when node TTL drains are allowed
    Ready bool
    Is the keyspace provisioned and serving traffic
    Replicas double
    Total number of replicas in the keyspace
    ReplicationDurabilityConstraints GetVitessKeyspacesDataReplicationDurabilityConstraints
    ResizeInProgress bool
    True while any unfinished resize request exists for the keyspace.
    ResizePending bool
    True while a resize request is queued.
    Resizing bool
    True while the keyspace is actively resizing.
    Sharded bool
    If the keyspace is sharded
    Shards double
    The number of keyspace shards
    UpdatedAt string
    When the keyspace was last updated
    VectorPoolAllocation double
    Percentage of buffer pool memory allocated to vector indexes
    VreplicationFlags GetVitessKeyspacesDataVreplicationFlags
    ClusterDisplayName string
    The SKU representing the keyspace cluster size for display
    ClusterSize string
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    ConfigChangeInProgress bool
    Is the keyspace undergoing a config change
    CreatedAt string
    When the keyspace was created
    ExtraReplicas float64
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    Id string
    The ID of the keyspace
    Imported bool
    Is this keyspace used in an import
    IsDefault bool
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    Metal bool
    Is the keyspace running on metal instances
    Name string
    Name of the keyspace
    NodeTtlStrategy string
    Controls when node TTL drains are allowed
    Ready bool
    Is the keyspace provisioned and serving traffic
    Replicas float64
    Total number of replicas in the keyspace
    ReplicationDurabilityConstraints GetVitessKeyspacesDataReplicationDurabilityConstraints
    ResizeInProgress bool
    True while any unfinished resize request exists for the keyspace.
    ResizePending bool
    True while a resize request is queued.
    Resizing bool
    True while the keyspace is actively resizing.
    Sharded bool
    If the keyspace is sharded
    Shards float64
    The number of keyspace shards
    UpdatedAt string
    When the keyspace was last updated
    VectorPoolAllocation float64
    Percentage of buffer pool memory allocated to vector indexes
    VreplicationFlags GetVitessKeyspacesDataVreplicationFlags
    cluster_display_name string
    The SKU representing the keyspace cluster size for display
    cluster_size string
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    config_change_in_progress bool
    Is the keyspace undergoing a config change
    created_at string
    When the keyspace was created
    extra_replicas number
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    id string
    The ID of the keyspace
    imported bool
    Is this keyspace used in an import
    is_default bool
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    metal bool
    Is the keyspace running on metal instances
    name string
    Name of the keyspace
    node_ttl_strategy string
    Controls when node TTL drains are allowed
    ready bool
    Is the keyspace provisioned and serving traffic
    replicas number
    Total number of replicas in the keyspace
    replication_durability_constraints object
    resize_in_progress bool
    True while any unfinished resize request exists for the keyspace.
    resize_pending bool
    True while a resize request is queued.
    resizing bool
    True while the keyspace is actively resizing.
    sharded bool
    If the keyspace is sharded
    shards number
    The number of keyspace shards
    updated_at string
    When the keyspace was last updated
    vector_pool_allocation number
    Percentage of buffer pool memory allocated to vector indexes
    vreplication_flags object
    clusterDisplayName String
    The SKU representing the keyspace cluster size for display
    clusterSize String
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    configChangeInProgress Boolean
    Is the keyspace undergoing a config change
    createdAt String
    When the keyspace was created
    extraReplicas Double
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    id String
    The ID of the keyspace
    imported Boolean
    Is this keyspace used in an import
    isDefault Boolean
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    metal Boolean
    Is the keyspace running on metal instances
    name String
    Name of the keyspace
    nodeTtlStrategy String
    Controls when node TTL drains are allowed
    ready Boolean
    Is the keyspace provisioned and serving traffic
    replicas Double
    Total number of replicas in the keyspace
    replicationDurabilityConstraints GetVitessKeyspacesDataReplicationDurabilityConstraints
    resizeInProgress Boolean
    True while any unfinished resize request exists for the keyspace.
    resizePending Boolean
    True while a resize request is queued.
    resizing Boolean
    True while the keyspace is actively resizing.
    sharded Boolean
    If the keyspace is sharded
    shards Double
    The number of keyspace shards
    updatedAt String
    When the keyspace was last updated
    vectorPoolAllocation Double
    Percentage of buffer pool memory allocated to vector indexes
    vreplicationFlags GetVitessKeyspacesDataVreplicationFlags
    clusterDisplayName string
    The SKU representing the keyspace cluster size for display
    clusterSize string
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    configChangeInProgress boolean
    Is the keyspace undergoing a config change
    createdAt string
    When the keyspace was created
    extraReplicas number
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    id string
    The ID of the keyspace
    imported boolean
    Is this keyspace used in an import
    isDefault boolean
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    metal boolean
    Is the keyspace running on metal instances
    name string
    Name of the keyspace
    nodeTtlStrategy string
    Controls when node TTL drains are allowed
    ready boolean
    Is the keyspace provisioned and serving traffic
    replicas number
    Total number of replicas in the keyspace
    replicationDurabilityConstraints GetVitessKeyspacesDataReplicationDurabilityConstraints
    resizeInProgress boolean
    True while any unfinished resize request exists for the keyspace.
    resizePending boolean
    True while a resize request is queued.
    resizing boolean
    True while the keyspace is actively resizing.
    sharded boolean
    If the keyspace is sharded
    shards number
    The number of keyspace shards
    updatedAt string
    When the keyspace was last updated
    vectorPoolAllocation number
    Percentage of buffer pool memory allocated to vector indexes
    vreplicationFlags GetVitessKeyspacesDataVreplicationFlags
    cluster_display_name str
    The SKU representing the keyspace cluster size for display
    cluster_size str
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    config_change_in_progress bool
    Is the keyspace undergoing a config change
    created_at str
    When the keyspace was created
    extra_replicas float
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    id str
    The ID of the keyspace
    imported bool
    Is this keyspace used in an import
    is_default bool
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    metal bool
    Is the keyspace running on metal instances
    name str
    Name of the keyspace
    node_ttl_strategy str
    Controls when node TTL drains are allowed
    ready bool
    Is the keyspace provisioned and serving traffic
    replicas float
    Total number of replicas in the keyspace
    replication_durability_constraints GetVitessKeyspacesDataReplicationDurabilityConstraints
    resize_in_progress bool
    True while any unfinished resize request exists for the keyspace.
    resize_pending bool
    True while a resize request is queued.
    resizing bool
    True while the keyspace is actively resizing.
    sharded bool
    If the keyspace is sharded
    shards float
    The number of keyspace shards
    updated_at str
    When the keyspace was last updated
    vector_pool_allocation float
    Percentage of buffer pool memory allocated to vector indexes
    vreplication_flags GetVitessKeyspacesDataVreplicationFlags
    clusterDisplayName String
    The SKU representing the keyspace cluster size for display
    clusterSize String
    The database cluster size name (e.g., PS_10, PS_80). Updates in place via a keyspace resize.
    configChangeInProgress Boolean
    Is the keyspace undergoing a config change
    createdAt String
    When the keyspace was created
    extraReplicas Number
    The number of additional replicas beyond the included default. Updates in place via a keyspace resize.
    id String
    The ID of the keyspace
    imported Boolean
    Is this keyspace used in an import
    isDefault Boolean
    True when this is the branch's default keyspace (usually created with the branch). Import that keyspace to manage its size or replicas.
    metal Boolean
    Is the keyspace running on metal instances
    name String
    Name of the keyspace
    nodeTtlStrategy String
    Controls when node TTL drains are allowed
    ready Boolean
    Is the keyspace provisioned and serving traffic
    replicas Number
    Total number of replicas in the keyspace
    replicationDurabilityConstraints Property Map
    resizeInProgress Boolean
    True while any unfinished resize request exists for the keyspace.
    resizePending Boolean
    True while a resize request is queued.
    resizing Boolean
    True while the keyspace is actively resizing.
    sharded Boolean
    If the keyspace is sharded
    shards Number
    The number of keyspace shards
    updatedAt String
    When the keyspace was last updated
    vectorPoolAllocation Number
    Percentage of buffer pool memory allocated to vector indexes
    vreplicationFlags Property Map

    GetVitessKeyspacesDataReplicationDurabilityConstraints

    Strategy string
    The replication durability strategy
    Strategy string
    The replication durability strategy
    strategy string
    The replication durability strategy
    strategy String
    The replication durability strategy
    strategy string
    The replication durability strategy
    strategy str
    The replication durability strategy
    strategy String
    The replication durability strategy

    GetVitessKeyspacesDataVreplicationFlags

    AllowNoBlobBinlogRowImage bool
    Allow no blob binlog row image
    OptimizeInserts bool
    Enable optimized inserts
    VplayerBatching bool
    Enable VPlayer batching
    AllowNoBlobBinlogRowImage bool
    Allow no blob binlog row image
    OptimizeInserts bool
    Enable optimized inserts
    VplayerBatching bool
    Enable VPlayer batching
    allow_no_blob_binlog_row_image bool
    Allow no blob binlog row image
    optimize_inserts bool
    Enable optimized inserts
    vplayer_batching bool
    Enable VPlayer batching
    allowNoBlobBinlogRowImage Boolean
    Allow no blob binlog row image
    optimizeInserts Boolean
    Enable optimized inserts
    vplayerBatching Boolean
    Enable VPlayer batching
    allowNoBlobBinlogRowImage boolean
    Allow no blob binlog row image
    optimizeInserts boolean
    Enable optimized inserts
    vplayerBatching boolean
    Enable VPlayer batching
    allow_no_blob_binlog_row_image bool
    Allow no blob binlog row image
    optimize_inserts bool
    Enable optimized inserts
    vplayer_batching bool
    Enable VPlayer batching
    allowNoBlobBinlogRowImage Boolean
    Allow no blob binlog row image
    optimizeInserts Boolean
    Enable optimized inserts
    vplayerBatching Boolean
    Enable VPlayer batching

    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.8.0
    published on Thursday, Aug 13, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial