getNekiShards

planetscale 1.11.0, Sep 18 26

Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale

planetscale/terraform-provider-planetscale

Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

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

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

import pulumi
import pulumi_planetscale as planetscale

my_nekishards = planetscale.get_neki_shards(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.GetNekiShards(ctx, &planetscale.GetNekiShardsArgs{
			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 myNekishards = Planetscale.GetNekiShards.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.GetNekiShardsArgs;
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 myNekishards = PlanetscaleFunctions.getNekiShards(GetNekiShardsArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .organization("...my_organization...")
            .build());

    }
}

variables:
  myNekishards:
    fn::invoke:
      function: planetscale:getNekiShards
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        organization: '...my_organization...'

Example coming soon!

Using getNekiShards

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 getNekiShards(args: GetNekiShardsArgs, opts?: InvokeOptions): Promise<GetNekiShardsResult>
function getNekiShardsOutput(args: GetNekiShardsOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiShardsResult>

def get_neki_shards(branch: Optional[str] = None,
                    database: Optional[str] = None,
                    organization: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNekiShardsResult
def get_neki_shards_output(branch: pulumi.Input[Optional[str]] = None,
                    database: pulumi.Input[Optional[str]] = None,
                    organization: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetNekiShardsResult]

func GetNekiShards(ctx *Context, args *GetNekiShardsArgs, opts ...InvokeOption) (*GetNekiShardsResult, error)
func GetNekiShardsOutput(ctx *Context, args *GetNekiShardsOutputArgs, opts ...InvokeOption) GetNekiShardsResultOutput

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

public static class GetNekiShards 
{
    public static Task<GetNekiShardsResult> InvokeAsync(GetNekiShardsArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiShardsResult> Invoke(GetNekiShardsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiShardsResult> Invoke(GetNekiShardsInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetNekiShardsResult> getNekiShards(GetNekiShardsArgs args, InvokeOptions options)
public static Output<GetNekiShardsResult> getNekiShards(GetNekiShardsArgs args, InvokeOptions options)
public static Output<GetNekiShardsResult> getNekiShards(GetNekiShardsArgs args, InvokeOutputOptions options)

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

data "planetscale_get_neki_shards" "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.
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.
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.
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.
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.
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.
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.
organization String: Organization name slug from list_organizations. Example: acme.

getNekiShards Result

The following output properties are available:

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Datas List<GetNekiShardsData>
Id string: The provider-assigned unique ID for this managed resource.
Organization string: Organization name slug from list_organizations. Example: acme.
Type string: The response type. Always "list" for paginated responses.

Branch string: Branch name from list_branches. Example: main.
Database string: Database name slug from list_databases. Example: app-db.
Datas []GetNekiShardsData
Id string: The provider-assigned unique ID for this managed resource.
Organization string: Organization name slug from list_organizations. Example: acme.
Type string: The response type. Always "list" for paginated responses.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
datas list(object)
id string: The provider-assigned unique ID for this managed resource.
organization string: Organization name slug from list_organizations. Example: acme.
type string: The response type. Always "list" for paginated responses.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
datas List<GetNekiShardsData>
id String: The provider-assigned unique ID for this managed resource.
organization String: Organization name slug from list_organizations. Example: acme.
type String: The response type. Always "list" for paginated responses.

branch string: Branch name from list_branches. Example: main.
database string: Database name slug from list_databases. Example: app-db.
datas GetNekiShardsData[]
id string: The provider-assigned unique ID for this managed resource.
organization string: Organization name slug from list_organizations. Example: acme.
type string: The response type. Always "list" for paginated responses.

branch str: Branch name from list_branches. Example: main.
database str: Database name slug from list_databases. Example: app-db.
datas Sequence[GetNekiShardsData]
id str: The provider-assigned unique ID for this managed resource.
organization str: Organization name slug from list_organizations. Example: acme.
type str: The response type. Always "list" for paginated responses.

branch String: Branch name from list_branches. Example: main.
database String: Database name slug from list_databases. Example: app-db.
datas List<Property Map>
id String: The provider-assigned unique ID for this managed resource.
organization String: Organization name slug from list_organizations. Example: acme.
type String: The response type. Always "list" for paginated responses.

Supporting Types

GetNekiShardsData

Authoritative bool: Whether the shard is the authoritative shard of the cluster
ConfigurationProfile string: The name of the shard configuration profile
DisplayName string: The display name of the shard
Id string: The ID of the shard
Ready bool: Whether the shard has been created on the cluster

Authoritative bool: Whether the shard is the authoritative shard of the cluster
ConfigurationProfile string: The name of the shard configuration profile
DisplayName string: The display name of the shard
Id string: The ID of the shard
Ready bool: Whether the shard has been created on the cluster

authoritative bool: Whether the shard is the authoritative shard of the cluster
configuration_profile string: The name of the shard configuration profile
display_name string: The display name of the shard
id string: The ID of the shard
ready bool: Whether the shard has been created on the cluster

authoritative Boolean: Whether the shard is the authoritative shard of the cluster
configurationProfile String: The name of the shard configuration profile
displayName String: The display name of the shard
id String: The ID of the shard
ready Boolean: Whether the shard has been created on the cluster

authoritative boolean: Whether the shard is the authoritative shard of the cluster
configurationProfile string: The name of the shard configuration profile
displayName string: The display name of the shard
id string: The ID of the shard
ready boolean: Whether the shard has been created on the cluster

authoritative bool: Whether the shard is the authoritative shard of the cluster
configuration_profile str: The name of the shard configuration profile
display_name str: The display name of the shard
id str: The ID of the shard
ready bool: Whether the shard has been created on the cluster

authoritative Boolean: Whether the shard is the authoritative shard of the cluster
configurationProfile String: The name of the shard configuration profile
displayName String: The display name of the shard
id String: The ID of the shard
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

planetscale.getNekiShards

On this page

On this page

Example Usage

Using getNekiShards

getNekiShards Result

Supporting Types

GetNekiShardsData

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

planetscale.getNekiShards

On this page

On this page

Example Usage

Using getNekiShards

getNekiShards Result

Supporting Types

GetNekiShardsData

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.