Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getNekiShard
Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getNekiShard

Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    Example Usage

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

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

    import pulumi
import pulumi_planetscale as planetscale

my_nekishard = planetscale.get_neki_shard(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.LookupNekiShard(ctx, &planetscale.LookupNekiShardArgs{
			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 myNekishard = Planetscale.GetNekiShard.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.GetNekiShardArgs;
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 myNekishard = PlanetscaleFunctions.getNekiShard(GetNekiShardArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .id("...my_id...")
            .organization("...my_organization...")
            .build());

    }
}

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

    Example coming soon!

    Using getNekiShard

    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 getNekiShard(args: GetNekiShardArgs, opts?: InvokeOptions): Promise<GetNekiShardResult>
function getNekiShardOutput(args: GetNekiShardOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiShardResult>
    def get_neki_shard(branch: Optional[str] = None,
                   database: Optional[str] = None,
                   id: Optional[str] = None,
                   organization: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetNekiShardResult
def get_neki_shard_output(branch: pulumi.Input[Optional[str]] = None,
                   database: pulumi.Input[Optional[str]] = None,
                   id: pulumi.Input[Optional[str]] = None,
                   organization: pulumi.Input[Optional[str]] = None,
                   opts: Optional[InvokeOutputOptions] = None) -> Output[GetNekiShardResult]
    func LookupNekiShard(ctx *Context, args *LookupNekiShardArgs, opts ...InvokeOption) (*LookupNekiShardResult, error)
func LookupNekiShardOutput(ctx *Context, args *LookupNekiShardOutputArgs, opts ...InvokeOption) LookupNekiShardResultOutput

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

    public static class GetNekiShard 
{
    public static Task<GetNekiShardResult> InvokeAsync(GetNekiShardArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiShardResult> Invoke(GetNekiShardInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiShardResult> Invoke(GetNekiShardInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetNekiShardResult> getNekiShard(GetNekiShardArgs args, InvokeOptions options)
public static Output<GetNekiShardResult> getNekiShard(GetNekiShardArgs args, InvokeOptions options)
public static Output<GetNekiShardResult> getNekiShard(GetNekiShardArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: planetscale:index/getNekiShard:getNekiShard
  arguments:
    # arguments dictionary
    data "planetscale_get_neki_shard" "name" {
    # arguments
}

    The following arguments are supported:

    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the shard
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the shard
    Organization string
    Organization name slug from list_organizations. Example: acme.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the shard
    organization string
    Organization name slug from list_organizations. Example: acme.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the shard
    organization String
    Organization name slug from list_organizations. Example: acme.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the shard
    organization string
    Organization name slug from list_organizations. Example: acme.
    branch str
    Branch name from list_branches. Example: main.
    database str
    Database name slug from list_databases. Example: app-db.
    id str
    The ID of the shard
    organization str
    Organization name slug from list_organizations. Example: acme.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the shard
    organization String
    Organization name slug from list_organizations. Example: acme.

    getNekiShard Result

    The following output properties are available:

    Authoritative bool
    Whether the shard is the authoritative shard of the cluster
    Branch string
    Branch name from list_branches. Example: main.
    ConfigurationProfile string
    The name of the shard configuration profile
    Database string
    Database name slug from list_databases. Example: app-db.
    DisplayName string
    The display name of the shard
    Id string
    The ID of the shard
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Ready bool
    Whether the shard has been created on the cluster
    Authoritative bool
    Whether the shard is the authoritative shard of the cluster
    Branch string
    Branch name from list_branches. Example: main.
    ConfigurationProfile string
    The name of the shard configuration profile
    Database string
    Database name slug from list_databases. Example: app-db.
    DisplayName string
    The display name of the shard
    Id string
    The ID of the shard
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Ready bool
    Whether the shard has been created on the cluster
    authoritative bool
    Whether the shard is the authoritative shard of the cluster
    branch string
    Branch name from list_branches. Example: main.
    configuration_profile string
    The name of the shard configuration profile
    database string
    Database name slug from list_databases. Example: app-db.
    display_name string
    The display name of the shard
    id string
    The ID of the shard
    organization string
    Organization name slug from list_organizations. Example: acme.
    ready bool
    Whether the shard has been created on the cluster
    authoritative Boolean
    Whether the shard is the authoritative shard of the cluster
    branch String
    Branch name from list_branches. Example: main.
    configurationProfile String
    The name of the shard configuration profile
    database String
    Database name slug from list_databases. Example: app-db.
    displayName String
    The display name of the shard
    id String
    The ID of the shard
    organization String
    Organization name slug from list_organizations. Example: acme.
    ready Boolean
    Whether the shard has been created on the cluster
    authoritative boolean
    Whether the shard is the authoritative shard of the cluster
    branch string
    Branch name from list_branches. Example: main.
    configurationProfile string
    The name of the shard configuration profile
    database string
    Database name slug from list_databases. Example: app-db.
    displayName string
    The display name of the shard
    id string
    The ID of the shard
    organization string
    Organization name slug from list_organizations. Example: acme.
    ready boolean
    Whether the shard has been created on the cluster
    authoritative bool
    Whether the shard is the authoritative shard of the cluster
    branch str
    Branch name from list_branches. Example: main.
    configuration_profile str
    The name of the shard configuration profile
    database str
    Database name slug from list_databases. Example: app-db.
    display_name str
    The display name of the shard
    id str
    The ID of the shard
    organization str
    Organization name slug from list_organizations. Example: acme.
    ready bool
    Whether the shard has been created on the cluster
    authoritative Boolean
    Whether the shard is the authoritative shard of the cluster
    branch String
    Branch name from list_branches. Example: main.
    configurationProfile String
    The name of the shard configuration profile
    database String
    Database name slug from list_databases. Example: app-db.
    displayName String
    The display name of the shard
    id String
    The ID of the shard
    organization String
    Organization name slug from list_organizations. Example: acme.
    ready Boolean
    Whether the shard has been created on the cluster

    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.11.0
    published on Friday, Sep 18, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial