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

planetscale.NekiRouter

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

    NekiRouter Resource

    Create NekiRouter Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NekiRouter(name: string, args: NekiRouterArgs, opts?: CustomResourceOptions);
    @overload
def NekiRouter(resource_name: str,
               args: NekiRouterArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def NekiRouter(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               branch: Optional[str] = None,
               database: Optional[str] = None,
               organization: Optional[str] = None,
               autoscaling: Optional[bool] = None,
               max_replicas_per_cell: Optional[float] = None,
               name: Optional[str] = None,
               replicas_per_cell: Optional[float] = None,
               router_size: Optional[str] = None,
               target_cpu_utilization: Optional[float] = None)
    func NewNekiRouter(ctx *Context, name string, args NekiRouterArgs, opts ...ResourceOption) (*NekiRouter, error)
    public NekiRouter(string name, NekiRouterArgs args, CustomResourceOptions? opts = null)
    public NekiRouter(String name, NekiRouterArgs args)
public NekiRouter(String name, NekiRouterArgs args, CustomResourceOptions options)

    type: planetscale:NekiRouter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "planetscale_neki_router" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args NekiRouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NekiRouterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NekiRouterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NekiRouterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NekiRouterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var nekiRouterResource = new Planetscale.NekiRouter("nekiRouterResource", new()
{
    Branch = "string",
    Database = "string",
    Organization = "string",
    Autoscaling = false,
    MaxReplicasPerCell = 0.0,
    Name = "string",
    ReplicasPerCell = 0.0,
    RouterSize = "string",
    TargetCpuUtilization = 0.0,
});

    example, err := planetscale.NewNekiRouter(ctx, "nekiRouterResource", &planetscale.NekiRouterArgs{
	Branch:               pulumi.String("string"),
	Database:             pulumi.String("string"),
	Organization:         pulumi.String("string"),
	Autoscaling:          pulumi.Bool(false),
	MaxReplicasPerCell:   pulumi.Float64(0),
	Name:                 pulumi.String("string"),
	ReplicasPerCell:      pulumi.Float64(0),
	RouterSize:           pulumi.String("string"),
	TargetCpuUtilization: pulumi.Float64(0),
})

    resource "planetscale_neki_router" "nekiRouterResource" {
  lifecycle {
    create_before_destroy = true
  }
  branch                 = "string"
  database               = "string"
  organization           = "string"
  autoscaling            = false
  max_replicas_per_cell  = 0
  name                   = "string"
  replicas_per_cell      = 0
  router_size            = "string"
  target_cpu_utilization = 0
}

    var nekiRouterResource = new NekiRouter("nekiRouterResource", NekiRouterArgs.builder()
    .branch("string")
    .database("string")
    .organization("string")
    .autoscaling(false)
    .maxReplicasPerCell(0.0)
    .name("string")
    .replicasPerCell(0.0)
    .routerSize("string")
    .targetCpuUtilization(0.0)
    .build());

    neki_router_resource = planetscale.NekiRouter("nekiRouterResource",
    branch="string",
    database="string",
    organization="string",
    autoscaling=False,
    max_replicas_per_cell=float(0),
    name="string",
    replicas_per_cell=float(0),
    router_size="string",
    target_cpu_utilization=float(0))

    const nekiRouterResource = new planetscale.NekiRouter("nekiRouterResource", {
    branch: "string",
    database: "string",
    organization: "string",
    autoscaling: false,
    maxReplicasPerCell: 0,
    name: "string",
    replicasPerCell: 0,
    routerSize: "string",
    targetCpuUtilization: 0,
});

    type: planetscale:NekiRouter
properties:
    autoscaling: false
    branch: string
    database: string
    maxReplicasPerCell: 0
    name: string
    organization: string
    replicasPerCell: 0
    routerSize: string
    targetCpuUtilization: 0

    NekiRouter Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The NekiRouter resource accepts the following input properties:

    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    Database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    Autoscaling bool
    Whether the router scales horizontally within each cell
    MaxReplicasPerCell double
    The maximum number of replicas in each cell when autoscaling
    Name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    ReplicasPerCell double
    The new number of replicas in each cell
    RouterSize string
    The new router size for the router
    TargetCpuUtilization double
    The target average CPU utilization percentage when autoscaling
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    Database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    Autoscaling bool
    Whether the router scales horizontally within each cell
    MaxReplicasPerCell float64
    The maximum number of replicas in each cell when autoscaling
    Name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    ReplicasPerCell float64
    The new number of replicas in each cell
    RouterSize string
    The new router size for the router
    TargetCpuUtilization float64
    The target average CPU utilization percentage when autoscaling
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    autoscaling bool
    Whether the router scales horizontally within each cell
    max_replicas_per_cell number
    The maximum number of replicas in each cell when autoscaling
    name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    replicas_per_cell number
    The new number of replicas in each cell
    router_size string
    The new router size for the router
    target_cpu_utilization number
    The target average CPU utilization percentage when autoscaling
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database String
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    autoscaling Boolean
    Whether the router scales horizontally within each cell
    maxReplicasPerCell Double
    The maximum number of replicas in each cell when autoscaling
    name String
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    replicasPerCell Double
    The new number of replicas in each cell
    routerSize String
    The new router size for the router
    targetCpuUtilization Double
    The target average CPU utilization percentage when autoscaling
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    autoscaling boolean
    Whether the router scales horizontally within each cell
    maxReplicasPerCell number
    The maximum number of replicas in each cell when autoscaling
    name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    replicasPerCell number
    The new number of replicas in each cell
    routerSize string
    The new router size for the router
    targetCpuUtilization number
    The target average CPU utilization percentage when autoscaling
    branch str
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database str
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    organization str
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    autoscaling bool
    Whether the router scales horizontally within each cell
    max_replicas_per_cell float
    The maximum number of replicas in each cell when autoscaling
    name str
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    replicas_per_cell float
    The new number of replicas in each cell
    router_size str
    The new router size for the router
    target_cpu_utilization float
    The target average CPU utilization percentage when autoscaling
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database String
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    autoscaling Boolean
    Whether the router scales horizontally within each cell
    maxReplicasPerCell Number
    The maximum number of replicas in each cell when autoscaling
    name String
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    replicasPerCell Number
    The new number of replicas in each cell
    routerSize String
    The new router size for the router
    targetCpuUtilization Number
    The target average CPU utilization percentage when autoscaling

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NekiRouter resource produces the following output properties:

    Default bool
    Whether this is the default router
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the router
    Default bool
    Whether this is the default router
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the router
    default bool
    Whether this is the default router
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the router
    default_ Boolean
    Whether this is the default router
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the router
    default boolean
    Whether this is the default router
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the router
    default bool
    Whether this is the default router
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the router
    default Boolean
    Whether this is the default router
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the router

    Look up Existing NekiRouter Resource

    Get an existing NekiRouter resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NekiRouterState, opts?: CustomResourceOptions): NekiRouter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscaling: Optional[bool] = None,
        branch: Optional[str] = None,
        database: Optional[str] = None,
        default: Optional[bool] = None,
        max_replicas_per_cell: Optional[float] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        replicas_per_cell: Optional[float] = None,
        router_size: Optional[str] = None,
        state: Optional[str] = None,
        target_cpu_utilization: Optional[float] = None) -> NekiRouter
    func GetNekiRouter(ctx *Context, name string, id IDInput, state *NekiRouterState, opts ...ResourceOption) (*NekiRouter, error)
    public static NekiRouter Get(string name, Input<string> id, NekiRouterState? state, CustomResourceOptions? opts = null)
    public static NekiRouter get(String name, Output<String> id, NekiRouterState state, CustomResourceOptions options)
    resources:  _:    type: planetscale:NekiRouter    get:      id: ${id}
    import {
  to = planetscale_neki_router.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Autoscaling bool
    Whether the router scales horizontally within each cell
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    Database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    Default bool
    Whether this is the default router
    MaxReplicasPerCell double
    The maximum number of replicas in each cell when autoscaling
    Name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    ReplicasPerCell double
    The new number of replicas in each cell
    RouterSize string
    The new router size for the router
    State string
    The current state of the router
    TargetCpuUtilization double
    The target average CPU utilization percentage when autoscaling
    Autoscaling bool
    Whether the router scales horizontally within each cell
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    Database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    Default bool
    Whether this is the default router
    MaxReplicasPerCell float64
    The maximum number of replicas in each cell when autoscaling
    Name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    ReplicasPerCell float64
    The new number of replicas in each cell
    RouterSize string
    The new router size for the router
    State string
    The current state of the router
    TargetCpuUtilization float64
    The target average CPU utilization percentage when autoscaling
    autoscaling bool
    Whether the router scales horizontally within each cell
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    default bool
    Whether this is the default router
    max_replicas_per_cell number
    The maximum number of replicas in each cell when autoscaling
    name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    replicas_per_cell number
    The new number of replicas in each cell
    router_size string
    The new router size for the router
    state string
    The current state of the router
    target_cpu_utilization number
    The target average CPU utilization percentage when autoscaling
    autoscaling Boolean
    Whether the router scales horizontally within each cell
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database String
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    default_ Boolean
    Whether this is the default router
    maxReplicasPerCell Double
    The maximum number of replicas in each cell when autoscaling
    name String
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    replicasPerCell Double
    The new number of replicas in each cell
    routerSize String
    The new router size for the router
    state String
    The current state of the router
    targetCpuUtilization Double
    The target average CPU utilization percentage when autoscaling
    autoscaling boolean
    Whether the router scales horizontally within each cell
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    default boolean
    Whether this is the default router
    maxReplicasPerCell number
    The maximum number of replicas in each cell when autoscaling
    name string
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    replicasPerCell number
    The new number of replicas in each cell
    routerSize string
    The new router size for the router
    state string
    The current state of the router
    targetCpuUtilization number
    The target average CPU utilization percentage when autoscaling
    autoscaling bool
    Whether the router scales horizontally within each cell
    branch str
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database str
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    default bool
    Whether this is the default router
    max_replicas_per_cell float
    The maximum number of replicas in each cell when autoscaling
    name str
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    organization str
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    replicas_per_cell float
    The new number of replicas in each cell
    router_size str
    The new router size for the router
    state str
    The current state of the router
    target_cpu_utilization float
    The target average CPU utilization percentage when autoscaling
    autoscaling Boolean
    Whether the router scales horizontally within each cell
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    database String
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    default Boolean
    Whether this is the default router
    maxReplicasPerCell Number
    The maximum number of replicas in each cell when autoscaling
    name String
    The name of the router group. Letters, digits, dashes, and underscores; 1-64 characters; cannot start or end with a dash or underscore. new, primary, and replica are reserved. Clients connect through the group by appending it to the username, e.g. user|my-router. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    replicasPerCell Number
    The new number of replicas in each cell
    routerSize String
    The new router size for the router
    state String
    The current state of the router
    targetCpuUtilization Number
    The target average CPU utilization percentage when autoscaling

    Import

    In Terraform v1.5.0 and later, the import block can be used with the id attribute, for example:

    terraform

    import {

    to = planetscale_neki_router.my_planetscale_neki_router

    id = jsonencode({

    branch       = "..."

database     = "..."

name         = "..."

organization = "..."

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import planetscale:index/nekiRouter:NekiRouter my_planetscale_neki_router '{"branch": "...", "database": "...", "name": "...", "organization": "..."}'

    To learn more about importing existing cloud resources, see Importing resources.

    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