getNekiRouters

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 myNekirouters = planetscale.getNekiRouters({
    branch: "...my_branch...",
    database: "...my_database...",
    organization: "...my_organization...",
});

import pulumi
import pulumi_planetscale as planetscale

my_nekirouters = planetscale.get_neki_routers(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.GetNekiRouters(ctx, &planetscale.GetNekiRoutersArgs{
			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 myNekirouters = Planetscale.GetNekiRouters.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.GetNekiRoutersArgs;
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 myNekirouters = PlanetscaleFunctions.getNekiRouters(GetNekiRoutersArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .organization("...my_organization...")
            .build());

    }
}

variables:
  myNekirouters:
    fn::invoke:
      function: planetscale:getNekiRouters
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        organization: '...my_organization...'

Example coming soon!

Using getNekiRouters

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 getNekiRouters(args: GetNekiRoutersArgs, opts?: InvokeOptions): Promise<GetNekiRoutersResult>
function getNekiRoutersOutput(args: GetNekiRoutersOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiRoutersResult>

def get_neki_routers(branch: Optional[str] = None,
                     database: Optional[str] = None,
                     organization: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNekiRoutersResult
def get_neki_routers_output(branch: pulumi.Input[Optional[str]] = None,
                     database: pulumi.Input[Optional[str]] = None,
                     organization: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetNekiRoutersResult]

func GetNekiRouters(ctx *Context, args *GetNekiRoutersArgs, opts ...InvokeOption) (*GetNekiRoutersResult, error)
func GetNekiRoutersOutput(ctx *Context, args *GetNekiRoutersOutputArgs, opts ...InvokeOption) GetNekiRoutersResultOutput

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

public static class GetNekiRouters 
{
    public static Task<GetNekiRoutersResult> InvokeAsync(GetNekiRoutersArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiRoutersResult> Invoke(GetNekiRoutersInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiRoutersResult> Invoke(GetNekiRoutersInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetNekiRoutersResult> getNekiRouters(GetNekiRoutersArgs args, InvokeOptions options)
public static Output<GetNekiRoutersResult> getNekiRouters(GetNekiRoutersArgs args, InvokeOptions options)
public static Output<GetNekiRoutersResult> getNekiRouters(GetNekiRoutersArgs args, InvokeOutputOptions options)

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

data "planetscale_get_neki_routers" "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.

getNekiRouters 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<GetNekiRoutersData>: Returns routers for the branch
Id string: The provider-assigned unique ID for this managed resource.
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.
Datas []GetNekiRoutersData: Returns routers for the branch
Id string: The provider-assigned unique ID for this managed resource.
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.
datas list(object): Returns routers for the branch
id string: The provider-assigned unique ID for this managed resource.
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.
datas List<GetNekiRoutersData>: Returns routers for the branch
id String: The provider-assigned unique ID for this managed resource.
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.
datas GetNekiRoutersData[]: Returns routers for the branch
id string: The provider-assigned unique ID for this managed resource.
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.
datas Sequence[GetNekiRoutersData]: Returns routers for the branch
id str: The provider-assigned unique ID for this managed resource.
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.
datas List<Property Map>: Returns routers for the branch
id String: The provider-assigned unique ID for this managed resource.
organization String: Organization name slug from list_organizations. Example: acme.

Supporting Types

GetNekiRoutersData

Autoscaling bool: Whether the router scales horizontally within each cell
Default bool: Whether this is the default router
Id string: The ID of the router
MaxReplicasPerCell double: The maximum count of replicas in each cell when autoscaling
Name string: The name of the router
ReplicasPerCell double: The count of replicas in each cell
RouterSize string: The router size SKU name
State string: The current state of the router
TargetCpuUtilization double: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

Autoscaling bool: Whether the router scales horizontally within each cell
Default bool: Whether this is the default router
Id string: The ID of the router
MaxReplicasPerCell float64: The maximum count of replicas in each cell when autoscaling
Name string: The name of the router
ReplicasPerCell float64: The count of replicas in each cell
RouterSize string: The router size SKU name
State string: The current state of the router
TargetCpuUtilization float64: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

autoscaling bool: Whether the router scales horizontally within each cell
default bool: Whether this is the default router
id string: The ID of the router
max_replicas_per_cell number: The maximum count of replicas in each cell when autoscaling
name string: The name of the router
replicas_per_cell number: The count of replicas in each cell
router_size string: The router size SKU name
state string: The current state of the router
target_cpu_utilization number: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

autoscaling Boolean: Whether the router scales horizontally within each cell
default_ Boolean: Whether this is the default router
id String: The ID of the router
maxReplicasPerCell Double: The maximum count of replicas in each cell when autoscaling
name String: The name of the router
replicasPerCell Double: The count of replicas in each cell
routerSize String: The router size SKU name
state String: The current state of the router
targetCpuUtilization Double: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

autoscaling boolean: Whether the router scales horizontally within each cell
default boolean: Whether this is the default router
id string: The ID of the router
maxReplicasPerCell number: The maximum count of replicas in each cell when autoscaling
name string: The name of the router
replicasPerCell number: The count of replicas in each cell
routerSize string: The router size SKU name
state string: The current state of the router
targetCpuUtilization number: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

autoscaling bool: Whether the router scales horizontally within each cell
default bool: Whether this is the default router
id str: The ID of the router
max_replicas_per_cell float: The maximum count of replicas in each cell when autoscaling
name str: The name of the router
replicas_per_cell float: The count of replicas in each cell
router_size str: The router size SKU name
state str: The current state of the router
target_cpu_utilization float: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

autoscaling Boolean: Whether the router scales horizontally within each cell
default Boolean: Whether this is the default router
id String: The ID of the router
maxReplicasPerCell Number: The maximum count of replicas in each cell when autoscaling
name String: The name of the router
replicasPerCell Number: The count of replicas in each cell
routerSize String: The router size SKU name
state String: The current state of the router
targetCpuUtilization Number: The target average CPU utilization percentage when autoscaling, one of 40, 50, 60 or 70

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.getNekiRouters

On this page

On this page

Example Usage

Using getNekiRouters

getNekiRouters Result

Supporting Types

GetNekiRoutersData

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

planetscale.getNekiRouters

On this page

On this page

Example Usage

Using getNekiRouters

getNekiRouters Result

Supporting Types

GetNekiRoutersData

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.