planetscale.getVitessKeyspace

planetscale 1.8.0, Aug 13 26

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale

planetscale/terraform-provider-planetscale

Viewing docs for planetscale 1.8.0
published on Thursday, Aug 13, 2026 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

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

const myVitesskeyspace = planetscale.getVitessKeyspace({
    branch: "...my_branch...",
    database: "...my_database...",
    name: "...my_name...",
    organization: "...my_organization...",
});

import pulumi
import pulumi_planetscale as planetscale

my_vitesskeyspace = planetscale.get_vitess_keyspace(branch="...my_branch...",
    database="...my_database...",
    name="...my_name...",
    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.LookupVitessKeyspace(ctx, &planetscale.LookupVitessKeyspaceArgs{
			Branch:       "...my_branch...",
			Database:     "...my_database...",
			Name:         "...my_name...",
			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 myVitesskeyspace = Planetscale.GetVitessKeyspace.Invoke(new()
    {
        Branch = "...my_branch...",
        Database = "...my_database...",
        Name = "...my_name...",
        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.GetVitessKeyspaceArgs;
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 myVitesskeyspace = PlanetscaleFunctions.getVitessKeyspace(GetVitessKeyspaceArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .name("...my_name...")
            .organization("...my_organization...")
            .build());

    }
}

variables:
  myVitesskeyspace:
    fn::invoke:
      function: planetscale:getVitessKeyspace
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        name: '...my_name...'
        organization: '...my_organization...'

Example coming soon!

Using getVitessKeyspace

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 getVitessKeyspace(args: GetVitessKeyspaceArgs, opts?: InvokeOptions): Promise<GetVitessKeyspaceResult>
function getVitessKeyspaceOutput(args: GetVitessKeyspaceOutputArgs, opts?: InvokeOutputOptions): Output<GetVitessKeyspaceResult>

def get_vitess_keyspace(branch: Optional[str] = None,
                        database: Optional[str] = None,
                        name: Optional[str] = None,
                        organization: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVitessKeyspaceResult
def get_vitess_keyspace_output(branch: pulumi.Input[Optional[str]] = None,
                        database: pulumi.Input[Optional[str]] = None,
                        name: pulumi.Input[Optional[str]] = None,
                        organization: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetVitessKeyspaceResult]

func LookupVitessKeyspace(ctx *Context, args *LookupVitessKeyspaceArgs, opts ...InvokeOption) (*LookupVitessKeyspaceResult, error)
func LookupVitessKeyspaceOutput(ctx *Context, args *LookupVitessKeyspaceOutputArgs, opts ...InvokeOption) LookupVitessKeyspaceResultOutput

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

public static class GetVitessKeyspace 
{
    public static Task<GetVitessKeyspaceResult> InvokeAsync(GetVitessKeyspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessKeyspaceResult> Invoke(GetVitessKeyspaceInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessKeyspaceResult> Invoke(GetVitessKeyspaceInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetVitessKeyspaceResult> getVitessKeyspace(GetVitessKeyspaceArgs args, InvokeOptions options)
public static Output<GetVitessKeyspaceResult> getVitessKeyspace(GetVitessKeyspaceArgs args, InvokeOptions options)
public static Output<GetVitessKeyspaceResult> getVitessKeyspace(GetVitessKeyspaceArgs args, InvokeOutputOptions options)

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

data "planetscale_get_vitess_keyspace" "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
Name string: Name of the keyspace
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
Name string: Name of the keyspace
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
name string: Name of the keyspace
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
name String: Name of the keyspace
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
name string: Name of the keyspace
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
name str: Name of the keyspace
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
name String: Name of the keyspace
organization String: The name of the organization the branch belongs to

getVitessKeyspace Result

The following output properties are available:

Branch string: The name of the branch
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
Database string: The name of the database the branch belongs to
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; do not try to create it with this resource.
Metal bool: Is the keyspace running on metal instances
Name string: Name of the keyspace
NodeTtlStrategy string: Controls when node TTL drains are allowed
Organization string: The name of the organization the branch belongs to
Ready bool: Is the keyspace provisioned and serving traffic
Replicas double: Total number of replicas in the keyspace
ReplicationDurabilityConstraints GetVitessKeyspaceReplicationDurabilityConstraints
ResizeInProgress bool: True while any unfinished resize request exists for the keyspace. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
ResizePending bool: True while a resize request is queued. The provider waits for this to become false after create and update.
Resizing bool: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
Sharded bool: If the keyspace is sharded
Shards double: The number of shards. Set only at create time; changing this value requires replacement.
UpdatedAt string: When the keyspace was last updated
VectorPoolAllocation double: Percentage of buffer pool memory allocated to vector indexes
VreplicationFlags GetVitessKeyspaceVreplicationFlags

Branch string: The name of the branch
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
Database string: The name of the database the branch belongs to
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; do not try to create it with this resource.
Metal bool: Is the keyspace running on metal instances
Name string: Name of the keyspace
NodeTtlStrategy string: Controls when node TTL drains are allowed
Organization string: The name of the organization the branch belongs to
Ready bool: Is the keyspace provisioned and serving traffic
Replicas float64: Total number of replicas in the keyspace
ReplicationDurabilityConstraints GetVitessKeyspaceReplicationDurabilityConstraints
ResizeInProgress bool: True while any unfinished resize request exists for the keyspace. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
ResizePending bool: True while a resize request is queued. The provider waits for this to become false after create and update.
Resizing bool: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
Sharded bool: If the keyspace is sharded
Shards float64: The number of shards. Set only at create time; changing this value requires replacement.
UpdatedAt string: When the keyspace was last updated
VectorPoolAllocation float64: Percentage of buffer pool memory allocated to vector indexes
VreplicationFlags GetVitessKeyspaceVreplicationFlags

branch string: The name of the branch
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
database string: The name of the database the branch belongs to
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; do not try to create it with this resource.
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
organization string: The name of the organization the branch belongs to
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. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
resize_pending bool: True while a resize request is queued. The provider waits for this to become false after create and update.
resizing bool: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
sharded bool: If the keyspace is sharded
shards number: The number of shards. Set only at create time; changing this value requires replacement.
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

branch String: The name of the branch
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
database String: The name of the database the branch belongs to
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; do not try to create it with this resource.
metal Boolean: Is the keyspace running on metal instances
name String: Name of the keyspace
nodeTtlStrategy String: Controls when node TTL drains are allowed
organization String: The name of the organization the branch belongs to
ready Boolean: Is the keyspace provisioned and serving traffic
replicas Double: Total number of replicas in the keyspace
replicationDurabilityConstraints GetVitessKeyspaceReplicationDurabilityConstraints
resizeInProgress Boolean: True while any unfinished resize request exists for the keyspace. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
resizePending Boolean: True while a resize request is queued. The provider waits for this to become false after create and update.
resizing Boolean: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
sharded Boolean: If the keyspace is sharded
shards Double: The number of shards. Set only at create time; changing this value requires replacement.
updatedAt String: When the keyspace was last updated
vectorPoolAllocation Double: Percentage of buffer pool memory allocated to vector indexes
vreplicationFlags GetVitessKeyspaceVreplicationFlags

branch string: The name of the branch
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
database string: The name of the database the branch belongs to
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; do not try to create it with this resource.
metal boolean: Is the keyspace running on metal instances
name string: Name of the keyspace
nodeTtlStrategy string: Controls when node TTL drains are allowed
organization string: The name of the organization the branch belongs to
ready boolean: Is the keyspace provisioned and serving traffic
replicas number: Total number of replicas in the keyspace
replicationDurabilityConstraints GetVitessKeyspaceReplicationDurabilityConstraints
resizeInProgress boolean: True while any unfinished resize request exists for the keyspace. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
resizePending boolean: True while a resize request is queued. The provider waits for this to become false after create and update.
resizing boolean: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
sharded boolean: If the keyspace is sharded
shards number: The number of shards. Set only at create time; changing this value requires replacement.
updatedAt string: When the keyspace was last updated
vectorPoolAllocation number: Percentage of buffer pool memory allocated to vector indexes
vreplicationFlags GetVitessKeyspaceVreplicationFlags

branch str: The name of the branch
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
database str: The name of the database the branch belongs to
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; do not try to create it with this resource.
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
organization str: The name of the organization the branch belongs to
ready bool: Is the keyspace provisioned and serving traffic
replicas float: Total number of replicas in the keyspace
replication_durability_constraints GetVitessKeyspaceReplicationDurabilityConstraints
resize_in_progress bool: True while any unfinished resize request exists for the keyspace. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
resize_pending bool: True while a resize request is queued. The provider waits for this to become false after create and update.
resizing bool: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
sharded bool: If the keyspace is sharded
shards float: The number of shards. Set only at create time; changing this value requires replacement.
updated_at str: When the keyspace was last updated
vector_pool_allocation float: Percentage of buffer pool memory allocated to vector indexes
vreplication_flags GetVitessKeyspaceVreplicationFlags

branch String: The name of the branch
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
database String: The name of the database the branch belongs to
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; do not try to create it with this resource.
metal Boolean: Is the keyspace running on metal instances
name String: Name of the keyspace
nodeTtlStrategy String: Controls when node TTL drains are allowed
organization String: The name of the organization the branch belongs to
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. Computed for observability; apply waits on ready, resizing, resizepending, and configchangeinprogress instead, because this flag can lag after the resize has already applied.
resizePending Boolean: True while a resize request is queued. The provider waits for this to become false after create and update.
resizing Boolean: True while the keyspace is actively resizing. The provider waits for this to become false after create and update.
sharded Boolean: If the keyspace is sharded
shards Number: The number of shards. Set only at create time; changing this value requires replacement.
updatedAt String: When the keyspace was last updated
vectorPoolAllocation Number: Percentage of buffer pool memory allocated to vector indexes
vreplicationFlags Property Map

Supporting Types

GetVitessKeyspaceReplicationDurabilityConstraints

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

GetVitessKeyspaceVreplicationFlags

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

planetscale.getVitessKeyspace

On this page

On this page

Example Usage

Using getVitessKeyspace

getVitessKeyspace Result

Supporting Types

GetVitessKeyspaceReplicationDurabilityConstraints

GetVitessKeyspaceVreplicationFlags

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

planetscale.getVitessKeyspace

On this page

On this page

Example Usage

Using getVitessKeyspace

getVitessKeyspace Result

Supporting Types

GetVitessKeyspaceReplicationDurabilityConstraints

GetVitessKeyspaceVreplicationFlags

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.