1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getNekiConfigurationProfile
Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale

    NekiConfigurationProfile DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as planetscale from "@pulumi/planetscale";
    
    const myNekiconfigurationprofile = planetscale.getNekiConfigurationProfile({
        organization: "acme",
        database: "app",
        branch: "main",
        name: "default",
    });
    export const enabledExtensions = myNekiconfigurationprofile.then(myNekiconfigurationprofile => myNekiconfigurationprofile.extensions);
    
    import pulumi
    import pulumi_planetscale as planetscale
    
    my_nekiconfigurationprofile = planetscale.get_neki_configuration_profile(organization="acme",
        database="app",
        branch="main",
        name="default")
    pulumi.export("enabledExtensions", my_nekiconfigurationprofile.extensions)
    
    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 {
    		myNekiconfigurationprofile, err := planetscale.LookupNekiConfigurationProfile(ctx, &planetscale.LookupNekiConfigurationProfileArgs{
    			Organization: "acme",
    			Database:     "app",
    			Branch:       "main",
    			Name:         "default",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("enabledExtensions", myNekiconfigurationprofile.Extensions)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Planetscale = Pulumi.Planetscale;
    
    return await Deployment.RunAsync(() => 
    {
        var myNekiconfigurationprofile = Planetscale.GetNekiConfigurationProfile.Invoke(new()
        {
            Organization = "acme",
            Database = "app",
            Branch = "main",
            Name = "default",
        });
    
        return new Dictionary<string, object?>
        {
            ["enabledExtensions"] = myNekiconfigurationprofile.Apply(getNekiConfigurationProfileResult => getNekiConfigurationProfileResult.Extensions),
        };
    });
    
    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.GetNekiConfigurationProfileArgs;
    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 myNekiconfigurationprofile = PlanetscaleFunctions.getNekiConfigurationProfile(GetNekiConfigurationProfileArgs.builder()
                .organization("acme")
                .database("app")
                .branch("main")
                .name("default")
                .build());
    
            ctx.export("enabledExtensions", myNekiconfigurationprofile.extensions());
        }
    }
    
    variables:
      myNekiconfigurationprofile:
        fn::invoke:
          function: planetscale:getNekiConfigurationProfile
          arguments:
            organization: acme
            database: app
            branch: main
            name: default
    outputs:
      enabledExtensions: ${myNekiconfigurationprofile.extensions}
    
    Example coming soon!
    

    Using getNekiConfigurationProfile

    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 getNekiConfigurationProfile(args: GetNekiConfigurationProfileArgs, opts?: InvokeOptions): Promise<GetNekiConfigurationProfileResult>
    function getNekiConfigurationProfileOutput(args: GetNekiConfigurationProfileOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiConfigurationProfileResult>
    def get_neki_configuration_profile(branch: Optional[str] = None,
                                       database: Optional[str] = None,
                                       extensions: Optional[Sequence[str]] = None,
                                       name: Optional[str] = None,
                                       organization: Optional[str] = None,
                                       parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetNekiConfigurationProfileResult
    def get_neki_configuration_profile_output(branch: pulumi.Input[Optional[str]] = None,
                                       database: pulumi.Input[Optional[str]] = None,
                                       extensions: pulumi.Input[Optional[Sequence[pulumi.Input[str]]]] = None,
                                       name: pulumi.Input[Optional[str]] = None,
                                       organization: pulumi.Input[Optional[str]] = None,
                                       parameters: pulumi.Input[Optional[Mapping[str, pulumi.Input[Mapping[str, pulumi.Input[str]]]]]] = None,
                                       opts: Optional[InvokeOutputOptions] = None) -> Output[GetNekiConfigurationProfileResult]
    func LookupNekiConfigurationProfile(ctx *Context, args *LookupNekiConfigurationProfileArgs, opts ...InvokeOption) (*LookupNekiConfigurationProfileResult, error)
    func LookupNekiConfigurationProfileOutput(ctx *Context, args *LookupNekiConfigurationProfileOutputArgs, opts ...InvokeOption) LookupNekiConfigurationProfileResultOutput

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

    public static class GetNekiConfigurationProfile 
    {
        public static Task<GetNekiConfigurationProfileResult> InvokeAsync(GetNekiConfigurationProfileArgs args, InvokeOptions? opts = null)
        public static Output<GetNekiConfigurationProfileResult> Invoke(GetNekiConfigurationProfileInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetNekiConfigurationProfileResult> Invoke(GetNekiConfigurationProfileInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetNekiConfigurationProfileResult> getNekiConfigurationProfile(GetNekiConfigurationProfileArgs args, InvokeOptions options)
    public static Output<GetNekiConfigurationProfileResult> getNekiConfigurationProfile(GetNekiConfigurationProfileArgs args, InvokeOptions options)
    public static Output<GetNekiConfigurationProfileResult> getNekiConfigurationProfile(GetNekiConfigurationProfileArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: planetscale:index/getNekiConfigurationProfile:getNekiConfigurationProfile
      arguments:
        # arguments dictionary
    data "planetscale_get_neki_configuration_profile" "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.
    Name string
    The name of the shard configuration profile
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Extensions List<string>
    Enabled extensions, excluding those required by PlanetScale.
    Parameters Dictionary<string, ImmutableDictionary<string, string>>
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Name string
    The name of the shard configuration profile
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Extensions []string
    Enabled extensions, excluding those required by PlanetScale.
    Parameters map[string]map[string]string
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    name string
    The name of the shard configuration profile
    organization string
    Organization name slug from list_organizations. Example: acme.
    extensions list(string)
    Enabled extensions, excluding those required by PlanetScale.
    parameters map(map(string))
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    name String
    The name of the shard configuration profile
    organization String
    Organization name slug from list_organizations. Example: acme.
    extensions List<String>
    Enabled extensions, excluding those required by PlanetScale.
    parameters Map<String,Map<String,String>>
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    name string
    The name of the shard configuration profile
    organization string
    Organization name slug from list_organizations. Example: acme.
    extensions string[]
    Enabled extensions, excluding those required by PlanetScale.
    parameters {[key: string]: {[key: string]: string}}
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    branch str
    Branch name from list_branches. Example: main.
    database str
    Database name slug from list_databases. Example: app-db.
    name str
    The name of the shard configuration profile
    organization str
    Organization name slug from list_organizations. Example: acme.
    extensions Sequence[str]
    Enabled extensions, excluding those required by PlanetScale.
    parameters Mapping[str, Mapping[str, str]]
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    name String
    The name of the shard configuration profile
    organization String
    Organization name slug from list_organizations. Example: acme.
    extensions List<String>
    Enabled extensions, excluding those required by PlanetScale.
    parameters Map<Map<String>>
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.

    getNekiConfigurationProfile Result

    The following output properties are available:

    Branch string
    Branch name from list_branches. Example: main.
    ClusterSize string
    The name of the cluster size SKU
    Database string
    Database name slug from list_databases. Example: app-db.
    Extensions List<string>
    Enabled extensions, excluding those required by PlanetScale.
    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
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Parameters Dictionary<string, ImmutableDictionary<string, string>>
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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 GetNekiConfigurationProfileStorage
    Branch string
    Branch name from list_branches. Example: main.
    ClusterSize string
    The name of the cluster size SKU
    Database string
    Database name slug from list_databases. Example: app-db.
    Extensions []string
    Enabled extensions, excluding those required by PlanetScale.
    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
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Parameters map[string]map[string]string
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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 GetNekiConfigurationProfileStorage
    branch string
    Branch name from list_branches. Example: main.
    cluster_size string
    The name of the cluster size SKU
    database string
    Database name slug from list_databases. Example: app-db.
    extensions list(string)
    Enabled extensions, excluding those required by PlanetScale.
    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
    organization string
    Organization name slug from list_organizations. Example: acme.
    parameters map(map(string))
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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
    branch String
    Branch name from list_branches. Example: main.
    clusterSize String
    The name of the cluster size SKU
    database String
    Database name slug from list_databases. Example: app-db.
    extensions List<String>
    Enabled extensions, excluding those required by PlanetScale.
    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
    organization String
    Organization name slug from list_organizations. Example: acme.
    parameters Map<String,Map<String,String>>
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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 GetNekiConfigurationProfileStorage
    branch string
    Branch name from list_branches. Example: main.
    clusterSize string
    The name of the cluster size SKU
    database string
    Database name slug from list_databases. Example: app-db.
    extensions string[]
    Enabled extensions, excluding those required by PlanetScale.
    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
    organization string
    Organization name slug from list_organizations. Example: acme.
    parameters {[key: string]: {[key: string]: string}}
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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 GetNekiConfigurationProfileStorage
    branch str
    Branch name from list_branches. Example: main.
    cluster_size str
    The name of the cluster size SKU
    database str
    Database name slug from list_databases. Example: app-db.
    extensions Sequence[str]
    Enabled extensions, excluding those required by PlanetScale.
    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
    organization str
    Organization name slug from list_organizations. Example: acme.
    parameters Mapping[str, Mapping[str, str]]
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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 GetNekiConfigurationProfileStorage
    branch String
    Branch name from list_branches. Example: main.
    clusterSize String
    The name of the cluster size SKU
    database String
    Database name slug from list_databases. Example: app-db.
    extensions List<String>
    Enabled extensions, excluding those required by PlanetScale.
    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
    organization String
    Organization name slug from list_organizations. Example: acme.
    parameters Map<Map<String>>
    Managed effective parameter values nested by namespace. Remote non-default values are adopted during reads. Preload library parameters are only included when managed directly.
    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

    Supporting Types

    GetNekiConfigurationProfileStorage

    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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial