NekiShard

planetscale 1.11.0, Sep 18 26

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

Schema (JSON)

planetscale/terraform-provider-planetscale

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

Schema (JSON)

planetscale/terraform-provider-planetscale

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_shard.my_planetscale_neki_shard

id = jsonencode({

branch       = "..."

database     = "..."

id           = "..."

organization = "..."

})

}

The pulumi import command can be used, for example:

$ pulumi import planetscale:index/nekiShard:NekiShard my_planetscale_neki_shard '{"branch": "...", "database": "...", "id": "...", "organization": "..."}'

Create NekiShard Resource

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

Constructor syntax

new NekiShard(name: string, args: NekiShardArgs, opts?: CustomResourceOptions);

@overload
def NekiShard(resource_name: str,
              args: NekiShardArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def NekiShard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              branch: Optional[str] = None,
              configuration_profile: Optional[str] = None,
              database: Optional[str] = None,
              organization: Optional[str] = None,
              display_name: Optional[str] = None)

func NewNekiShard(ctx *Context, name string, args NekiShardArgs, opts ...ResourceOption) (*NekiShard, error)

public NekiShard(string name, NekiShardArgs args, CustomResourceOptions? opts = null)

public NekiShard(String name, NekiShardArgs args)
public NekiShard(String name, NekiShardArgs args, CustomResourceOptions options)

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

resource "planetscale_neki_shard" "name" {
    # resource properties
}

Parameters

name string: The unique name of the resource.
args NekiShardArgs: 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 NekiShardArgs: 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 NekiShardArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args NekiShardArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args NekiShardArgs: 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 nekiShardResource = new Planetscale.NekiShard("nekiShardResource", new()
{
    Branch = "string",
    ConfigurationProfile = "string",
    Database = "string",
    Organization = "string",
    DisplayName = "string",
});

example, err := planetscale.NewNekiShard(ctx, "nekiShardResource", &planetscale.NekiShardArgs{
	Branch:               pulumi.String("string"),
	ConfigurationProfile: pulumi.String("string"),
	Database:             pulumi.String("string"),
	Organization:         pulumi.String("string"),
	DisplayName:          pulumi.String("string"),
})

resource "planetscale_neki_shard" "nekiShardResource" {
  lifecycle {
    create_before_destroy = true
  }
  branch                = "string"
  configuration_profile = "string"
  database              = "string"
  organization          = "string"
  display_name          = "string"
}

var nekiShardResource = new NekiShard("nekiShardResource", NekiShardArgs.builder()
    .branch("string")
    .configurationProfile("string")
    .database("string")
    .organization("string")
    .displayName("string")
    .build());

neki_shard_resource = planetscale.NekiShard("nekiShardResource",
    branch="string",
    configuration_profile="string",
    database="string",
    organization="string",
    display_name="string")

const nekiShardResource = new planetscale.NekiShard("nekiShardResource", {
    branch: "string",
    configurationProfile: "string",
    database: "string",
    organization: "string",
    displayName: "string",
});

type: planetscale:NekiShard
properties:
    branch: string
    configurationProfile: string
    database: string
    displayName: string
    organization: string

NekiShard 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 NekiShard resource accepts the following input properties:

Branch string: Branch name from list_branches. Example: main. Requires replacement if changed.
ConfigurationProfile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
DisplayName string: Optional human-readable display name for the shard.

Branch string: Branch name from list_branches. Example: main. Requires replacement if changed.
ConfigurationProfile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
DisplayName string: Optional human-readable display name for the shard.

branch string: Branch name from list_branches. Example: main. Requires replacement if changed.
configuration_profile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
display_name string: Optional human-readable display name for the shard.

branch String: Branch name from list_branches. Example: main. Requires replacement if changed.
configurationProfile String: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
displayName String: Optional human-readable display name for the shard.

branch string: Branch name from list_branches. Example: main. Requires replacement if changed.
configurationProfile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
displayName string: Optional human-readable display name for the shard.

branch str: Branch name from list_branches. Example: main. Requires replacement if changed.
configuration_profile str: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
display_name str: Optional human-readable display name for the shard.

branch String: Branch name from list_branches. Example: main. Requires replacement if changed.
configurationProfile String: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
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.
displayName String: Optional human-readable display name for the shard.

Outputs

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

Authoritative bool: Whether the shard is the authoritative shard of the cluster
Id string: The provider-assigned unique ID for this managed resource.
Ready bool: Whether the shard has been created on the cluster

Authoritative bool: Whether the shard is the authoritative shard of the cluster
Id string: The provider-assigned unique ID for this managed resource.
Ready bool: Whether the shard has been created on the cluster

authoritative bool: Whether the shard is the authoritative shard of the cluster
id string: The provider-assigned unique ID for this managed resource.
ready bool: Whether the shard has been created on the cluster

authoritative Boolean: Whether the shard is the authoritative shard of the cluster
id String: The provider-assigned unique ID for this managed resource.
ready Boolean: Whether the shard has been created on the cluster

authoritative boolean: Whether the shard is the authoritative shard of the cluster
id string: The provider-assigned unique ID for this managed resource.
ready boolean: Whether the shard has been created on the cluster

authoritative bool: Whether the shard is the authoritative shard of the cluster
id str: The provider-assigned unique ID for this managed resource.
ready bool: Whether the shard has been created on the cluster

authoritative Boolean: Whether the shard is the authoritative shard of the cluster
id String: The provider-assigned unique ID for this managed resource.
ready Boolean: Whether the shard has been created on the cluster

Look up Existing NekiShard Resource

Get an existing NekiShard 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?: NekiShardState, opts?: CustomResourceOptions): NekiShard

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        authoritative: Optional[bool] = None,
        branch: Optional[str] = None,
        configuration_profile: Optional[str] = None,
        database: Optional[str] = None,
        display_name: Optional[str] = None,
        organization: Optional[str] = None,
        ready: Optional[bool] = None) -> NekiShard

func GetNekiShard(ctx *Context, name string, id IDInput, state *NekiShardState, opts ...ResourceOption) (*NekiShard, error)

public static NekiShard Get(string name, Input<string> id, NekiShardState? state, CustomResourceOptions? opts = null)

public static NekiShard get(String name, Output<String> id, NekiShardState state, CustomResourceOptions options)

resources:  _:    type: planetscale:NekiShard    get:      id: ${id}

import {
  to = planetscale_neki_shard.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:

Authoritative bool: Whether the shard is the authoritative shard of the cluster
Branch string: Branch name from list_branches. Example: main. Requires replacement if changed.
ConfigurationProfile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
Database string: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
DisplayName string: Optional human-readable display name for the shard.
Organization string: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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. Requires replacement if changed.
ConfigurationProfile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
Database string: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
DisplayName string: Optional human-readable display name for the shard.
Organization string: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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. Requires replacement if changed.
configuration_profile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
database string: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
display_name string: Optional human-readable display name for the shard.
organization string: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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. Requires replacement if changed.
configurationProfile String: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
database String: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
displayName String: Optional human-readable display name for the shard.
organization String: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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. Requires replacement if changed.
configurationProfile string: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
database string: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
displayName string: Optional human-readable display name for the shard.
organization string: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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. Requires replacement if changed.
configuration_profile str: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
database str: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
display_name str: Optional human-readable display name for the shard.
organization str: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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. Requires replacement if changed.
configurationProfile String: Configuration profile that owns the shard. Changing this value reassigns the shard in place and waits for the asynchronous configuration change to complete.
database String: Database name slug from list_databases. Example: app-db. Requires replacement if changed.
displayName String: Optional human-readable display name for the shard.
organization String: Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
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.NekiShard

On this page

On this page

Import

Create NekiShard Resource

Constructor syntax

Parameters

Constructor example

NekiShard Resource Properties

Inputs

Outputs

Look up Existing NekiShard Resource

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

planetscale.NekiShard

On this page

On this page

Import

Create NekiShard Resource

Constructor syntax

Parameters

Constructor example

NekiShard Resource Properties

Inputs

Outputs

Look up Existing NekiShard Resource

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.