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

planetscale.getNekiConfigurationProfiles

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

    List shard configuration profiles for a PlanetScale Neki branch.

    Example Usage

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

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

    import pulumi
import pulumi_planetscale as planetscale

my_nekiconfigurationprofiles = planetscale.get_neki_configuration_profiles(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.GetNekiConfigurationProfiles(ctx, &planetscale.GetNekiConfigurationProfilesArgs{
			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 myNekiconfigurationprofiles = Planetscale.GetNekiConfigurationProfiles.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.GetNekiConfigurationProfilesArgs;
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 myNekiconfigurationprofiles = PlanetscaleFunctions.getNekiConfigurationProfiles(GetNekiConfigurationProfilesArgs.builder()
            .branch("...my_branch...")
            .database("...my_database...")
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myNekiconfigurationprofiles:
    fn::invoke:
      function: planetscale:getNekiConfigurationProfiles
      arguments:
        branch: '...my_branch...'
        database: '...my_database...'
        organization: '...my_organization...'

    Example coming soon!

    Using getNekiConfigurationProfiles

    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 getNekiConfigurationProfiles(args: GetNekiConfigurationProfilesArgs, opts?: InvokeOptions): Promise<GetNekiConfigurationProfilesResult>
function getNekiConfigurationProfilesOutput(args: GetNekiConfigurationProfilesOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiConfigurationProfilesResult>
    def get_neki_configuration_profiles(branch: Optional[str] = None,
                                    database: Optional[str] = None,
                                    organization: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetNekiConfigurationProfilesResult
def get_neki_configuration_profiles_output(branch: pulumi.Input[Optional[str]] = None,
                                    database: pulumi.Input[Optional[str]] = None,
                                    organization: pulumi.Input[Optional[str]] = None,
                                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetNekiConfigurationProfilesResult]
    func GetNekiConfigurationProfiles(ctx *Context, args *GetNekiConfigurationProfilesArgs, opts ...InvokeOption) (*GetNekiConfigurationProfilesResult, error)
func GetNekiConfigurationProfilesOutput(ctx *Context, args *GetNekiConfigurationProfilesOutputArgs, opts ...InvokeOption) GetNekiConfigurationProfilesResultOutput

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

    public static class GetNekiConfigurationProfiles 
{
    public static Task<GetNekiConfigurationProfilesResult> InvokeAsync(GetNekiConfigurationProfilesArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiConfigurationProfilesResult> Invoke(GetNekiConfigurationProfilesInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiConfigurationProfilesResult> Invoke(GetNekiConfigurationProfilesInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetNekiConfigurationProfilesResult> getNekiConfigurationProfiles(GetNekiConfigurationProfilesArgs args, InvokeOptions options)
public static Output<GetNekiConfigurationProfilesResult> getNekiConfigurationProfiles(GetNekiConfigurationProfilesArgs args, InvokeOptions options)
public static Output<GetNekiConfigurationProfilesResult> getNekiConfigurationProfiles(GetNekiConfigurationProfilesArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: planetscale:index/getNekiConfigurationProfiles:getNekiConfigurationProfiles
  arguments:
    # arguments dictionary
    data "planetscale_get_neki_configuration_profiles" "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.

    getNekiConfigurationProfiles 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<GetNekiConfigurationProfilesData>
    Returns shard configuration profiles 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 []GetNekiConfigurationProfilesData
    Returns shard configuration profiles 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 shard configuration profiles 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<GetNekiConfigurationProfilesData>
    Returns shard configuration profiles 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 GetNekiConfigurationProfilesData[]
    Returns shard configuration profiles 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[GetNekiConfigurationProfilesData]
    Returns shard configuration profiles 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 shard configuration profiles 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

    GetNekiConfigurationProfilesData

    ClusterSize string
    The name of the cluster size SKU
    Id string
    The ID of the shard configuration profile
    IsDefault bool
    Whether this is the default shard configuration profile
    Name string
    The name of the shard configuration profile
    PostgresMajorVersion double
    The PostgreSQL major version used by the shard configuration profile
    PostgresMinorVersion double
    The PostgreSQL minor version used by the shard configuration profile
    Replicas double
    The number of replicas for shards using this configuration profile
    ShardCount double
    The number of shards using this configuration profile
    State string
    The current state of the shard configuration profile
    Storage GetNekiConfigurationProfilesDataStorage
    ClusterSize string
    The name of the cluster size SKU
    Id string
    The ID of the shard configuration profile
    IsDefault bool
    Whether this is the default shard configuration profile
    Name string
    The name of the shard configuration profile
    PostgresMajorVersion float64
    The PostgreSQL major version used by the shard configuration profile
    PostgresMinorVersion float64
    The PostgreSQL minor version used by the shard configuration profile
    Replicas float64
    The number of replicas for shards using this configuration profile
    ShardCount float64
    The number of shards using this configuration profile
    State string
    The current state of the shard configuration profile
    Storage GetNekiConfigurationProfilesDataStorage
    cluster_size string
    The name of the cluster size SKU
    id string
    The ID of the shard configuration profile
    is_default bool
    Whether this is the default shard configuration profile
    name string
    The name of the shard configuration profile
    postgres_major_version number
    The PostgreSQL major version used by the shard configuration profile
    postgres_minor_version number
    The PostgreSQL minor version used by the shard configuration profile
    replicas number
    The number of replicas for shards using this configuration profile
    shard_count number
    The number of shards using this configuration profile
    state string
    The current state of the shard configuration profile
    storage object
    clusterSize String
    The name of the cluster size SKU
    id String
    The ID of the shard configuration profile
    isDefault Boolean
    Whether this is the default shard configuration profile
    name String
    The name of the shard configuration profile
    postgresMajorVersion Double
    The PostgreSQL major version used by the shard configuration profile
    postgresMinorVersion Double
    The PostgreSQL minor version used by the shard configuration profile
    replicas Double
    The number of replicas for shards using this configuration profile
    shardCount Double
    The number of shards using this configuration profile
    state String
    The current state of the shard configuration profile
    storage GetNekiConfigurationProfilesDataStorage
    clusterSize string
    The name of the cluster size SKU
    id string
    The ID of the shard configuration profile
    isDefault boolean
    Whether this is the default shard configuration profile
    name string
    The name of the shard configuration profile
    postgresMajorVersion number
    The PostgreSQL major version used by the shard configuration profile
    postgresMinorVersion number
    The PostgreSQL minor version used by the shard configuration profile
    replicas number
    The number of replicas for shards using this configuration profile
    shardCount number
    The number of shards using this configuration profile
    state string
    The current state of the shard configuration profile
    storage GetNekiConfigurationProfilesDataStorage
    cluster_size str
    The name of the cluster size SKU
    id str
    The ID of the shard configuration profile
    is_default bool
    Whether this is the default shard configuration profile
    name str
    The name of the shard configuration profile
    postgres_major_version float
    The PostgreSQL major version used by the shard configuration profile
    postgres_minor_version float
    The PostgreSQL minor version used by the shard configuration profile
    replicas float
    The number of replicas for shards using this configuration profile
    shard_count float
    The number of shards using this configuration profile
    state str
    The current state of the shard configuration profile
    storage GetNekiConfigurationProfilesDataStorage
    clusterSize String
    The name of the cluster size SKU
    id String
    The ID of the shard configuration profile
    isDefault Boolean
    Whether this is the default shard configuration profile
    name String
    The name of the shard configuration profile
    postgresMajorVersion Number
    The PostgreSQL major version used by the shard configuration profile
    postgresMinorVersion Number
    The PostgreSQL minor version used by the shard configuration profile
    replicas Number
    The number of replicas for shards using this configuration profile
    shardCount Number
    The number of shards using this configuration profile
    state String
    The current state of the shard configuration profile
    storage Property Map

    GetNekiConfigurationProfilesDataStorage

    MaximumStorageBytes double
    The maximum storage size in bytes for autoscaling
    MinimumStorageBytes double
    The minimum storage size in bytes
    StorageAutoscaling bool
    Whether storage autoscaling is enabled
    StorageIops double
    The storage IOPS
    StorageThroughputMibs double
    The storage throughput in MiB/s
    MaximumStorageBytes float64
    The maximum storage size in bytes for autoscaling
    MinimumStorageBytes float64
    The minimum storage size in bytes
    StorageAutoscaling bool
    Whether storage autoscaling is enabled
    StorageIops float64
    The storage IOPS
    StorageThroughputMibs float64
    The storage throughput in MiB/s
    maximum_storage_bytes number
    The maximum storage size in bytes for autoscaling
    minimum_storage_bytes number
    The minimum storage size in bytes
    storage_autoscaling bool
    Whether storage autoscaling is enabled
    storage_iops number
    The storage IOPS
    storage_throughput_mibs number
    The storage throughput in MiB/s
    maximumStorageBytes Double
    The maximum storage size in bytes for autoscaling
    minimumStorageBytes Double
    The minimum storage size in bytes
    storageAutoscaling Boolean
    Whether storage autoscaling is enabled
    storageIops Double
    The storage IOPS
    storageThroughputMibs Double
    The storage throughput in MiB/s
    maximumStorageBytes number
    The maximum storage size in bytes for autoscaling
    minimumStorageBytes number
    The minimum storage size in bytes
    storageAutoscaling boolean
    Whether storage autoscaling is enabled
    storageIops number
    The storage IOPS
    storageThroughputMibs number
    The storage throughput in MiB/s
    maximum_storage_bytes float
    The maximum storage size in bytes for autoscaling
    minimum_storage_bytes float
    The minimum storage size in bytes
    storage_autoscaling bool
    Whether storage autoscaling is enabled
    storage_iops float
    The storage IOPS
    storage_throughput_mibs float
    The storage throughput in MiB/s
    maximumStorageBytes Number
    The maximum storage size in bytes for autoscaling
    minimumStorageBytes Number
    The minimum storage size in bytes
    storageAutoscaling Boolean
    Whether storage autoscaling is enabled
    storageIops Number
    The storage IOPS
    storageThroughputMibs Number
    The storage throughput in MiB/s

    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