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

planetscale.NekiConfigurationProfile

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_configuration_profile.my_planetscale_neki_configuration_profile

    id = jsonencode({

    branch       = "..."

database     = "..."

name         = "..."

organization = "..."

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import planetscale:index/nekiConfigurationProfile:NekiConfigurationProfile my_planetscale_neki_configuration_profile '{"branch": "...", "database": "...", "name": "...", "organization": "..."}'

    Create NekiConfigurationProfile Resource

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

    Constructor syntax

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

@overload
def NekiConfigurationProfile(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             branch: Optional[str] = None,
                             database: Optional[str] = None,
                             organization: Optional[str] = None,
                             cluster_size: Optional[str] = None,
                             extensions: Optional[Sequence[str]] = None,
                             name: Optional[str] = None,
                             parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
                             postgres_major_version: Optional[float] = None,
                             postgres_minor_version: Optional[float] = None,
                             replicas: Optional[float] = None,
                             storage: Optional[NekiConfigurationProfileStorageArgs] = None)
    func NewNekiConfigurationProfile(ctx *Context, name string, args NekiConfigurationProfileArgs, opts ...ResourceOption) (*NekiConfigurationProfile, error)
    public NekiConfigurationProfile(string name, NekiConfigurationProfileArgs args, CustomResourceOptions? opts = null)
    public NekiConfigurationProfile(String name, NekiConfigurationProfileArgs args)
public NekiConfigurationProfile(String name, NekiConfigurationProfileArgs args, CustomResourceOptions options)

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


    resource "planetscale_neki_configuration_profile" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args NekiConfigurationProfileArgs
    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 NekiConfigurationProfileArgs
    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 NekiConfigurationProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NekiConfigurationProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NekiConfigurationProfileArgs
    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 nekiConfigurationProfileResource = new Planetscale.NekiConfigurationProfile("nekiConfigurationProfileResource", new()
{
    Branch = "string",
    Database = "string",
    Organization = "string",
    ClusterSize = "string",
    Extensions = new[]
    {
        "string",
    },
    Name = "string",
    Parameters = 
    {
        { "string", new InputMap<string>
        {
            { "string", "string" },
        } },
    },
    PostgresMajorVersion = 0.0,
    PostgresMinorVersion = 0.0,
    Replicas = 0.0,
    Storage = new Planetscale.Inputs.NekiConfigurationProfileStorageArgs
    {
        MaximumStorageBytes = 0.0,
        MinimumStorageBytes = 0.0,
        StorageAutoscaling = false,
        StorageIops = 0.0,
        StorageThroughputMibs = 0.0,
    },
});

    example, err := planetscale.NewNekiConfigurationProfile(ctx, "nekiConfigurationProfileResource", &planetscale.NekiConfigurationProfileArgs{
	Branch:       pulumi.String("string"),
	Database:     pulumi.String("string"),
	Organization: pulumi.String("string"),
	ClusterSize:  pulumi.String("string"),
	Extensions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Parameters: pulumi.StringMapMap{
		"string": pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	PostgresMajorVersion: pulumi.Float64(0),
	PostgresMinorVersion: pulumi.Float64(0),
	Replicas:             pulumi.Float64(0),
	Storage: &planetscale.NekiConfigurationProfileStorageArgs{
		MaximumStorageBytes:   pulumi.Float64(0),
		MinimumStorageBytes:   pulumi.Float64(0),
		StorageAutoscaling:    pulumi.Bool(false),
		StorageIops:           pulumi.Float64(0),
		StorageThroughputMibs: pulumi.Float64(0),
	},
})

    resource "planetscale_neki_configuration_profile" "nekiConfigurationProfileResource" {
  lifecycle {
    create_before_destroy = true
  }
  branch       = "string"
  database     = "string"
  organization = "string"
  cluster_size = "string"
  extensions   = ["string"]
  name         = "string"
  parameters = {
    "string" = {
      "string" = "string"
    }
  }
  postgres_major_version = 0
  postgres_minor_version = 0
  replicas               = 0
  storage = {
    maximum_storage_bytes   = 0
    minimum_storage_bytes   = 0
    storage_autoscaling     = false
    storage_iops            = 0
    storage_throughput_mibs = 0
  }
}

    var nekiConfigurationProfileResource = new NekiConfigurationProfile("nekiConfigurationProfileResource", NekiConfigurationProfileArgs.builder()
    .branch("string")
    .database("string")
    .organization("string")
    .clusterSize("string")
    .extensions("string")
    .name("string")
    .parameters(Map.of("string", Map.of("string", "string")))
    .postgresMajorVersion(0.0)
    .postgresMinorVersion(0.0)
    .replicas(0.0)
    .storage(NekiConfigurationProfileStorageArgs.builder()
        .maximumStorageBytes(0.0)
        .minimumStorageBytes(0.0)
        .storageAutoscaling(false)
        .storageIops(0.0)
        .storageThroughputMibs(0.0)
        .build())
    .build());

    neki_configuration_profile_resource = planetscale.NekiConfigurationProfile("nekiConfigurationProfileResource",
    branch="string",
    database="string",
    organization="string",
    cluster_size="string",
    extensions=["string"],
    name="string",
    parameters={
        "string": {
            "string": "string",
        },
    },
    postgres_major_version=float(0),
    postgres_minor_version=float(0),
    replicas=float(0),
    storage={
        "maximum_storage_bytes": float(0),
        "minimum_storage_bytes": float(0),
        "storage_autoscaling": False,
        "storage_iops": float(0),
        "storage_throughput_mibs": float(0),
    })

    const nekiConfigurationProfileResource = new planetscale.NekiConfigurationProfile("nekiConfigurationProfileResource", {
    branch: "string",
    database: "string",
    organization: "string",
    clusterSize: "string",
    extensions: ["string"],
    name: "string",
    parameters: {
        string: {
            string: "string",
        },
    },
    postgresMajorVersion: 0,
    postgresMinorVersion: 0,
    replicas: 0,
    storage: {
        maximumStorageBytes: 0,
        minimumStorageBytes: 0,
        storageAutoscaling: false,
        storageIops: 0,
        storageThroughputMibs: 0,
    },
});

    type: planetscale:NekiConfigurationProfile
properties:
    branch: string
    clusterSize: string
    database: string
    extensions:
        - string
    name: string
    organization: string
    parameters:
        string:
            string: string
    postgresMajorVersion: 0
    postgresMinorVersion: 0
    replicas: 0
    storage:
        maximumStorageBytes: 0
        minimumStorageBytes: 0
        storageAutoscaling: false
        storageIops: 0
        storageThroughputMibs: 0

    NekiConfigurationProfile 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 NekiConfigurationProfile 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.
    ClusterSize string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    Extensions List<string>
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    Name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    Parameters Dictionary<string, ImmutableDictionary<string, string>>
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    PostgresMajorVersion double
    The PostgreSQL major version for the shard configuration profile
    PostgresMinorVersion double
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    Replicas double
    The new number of replicas for the shard configuration profile
    Storage NekiConfigurationProfileStorage
    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.
    ClusterSize string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    Extensions []string
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    Name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    Parameters map[string]map[string]string
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    PostgresMajorVersion float64
    The PostgreSQL major version for the shard configuration profile
    PostgresMinorVersion float64
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    Replicas float64
    The new number of replicas for the shard configuration profile
    Storage NekiConfigurationProfileStorageArgs
    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.
    cluster_size string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    extensions list(string)
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    parameters map(map(string))
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgres_major_version number
    The PostgreSQL major version for the shard configuration profile
    postgres_minor_version number
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas number
    The new number of replicas for the shard configuration profile
    storage object
    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.
    clusterSize String
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    extensions List<String>
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    name String
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    parameters Map<String,Map<String,String>>
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgresMajorVersion Double
    The PostgreSQL major version for the shard configuration profile
    postgresMinorVersion Double
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas Double
    The new number of replicas for the shard configuration profile
    storage NekiConfigurationProfileStorage
    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.
    clusterSize string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    extensions string[]
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    parameters {[key: string]: {[key: string]: string}}
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgresMajorVersion number
    The PostgreSQL major version for the shard configuration profile
    postgresMinorVersion number
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas number
    The new number of replicas for the shard configuration profile
    storage NekiConfigurationProfileStorage
    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.
    cluster_size str
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    extensions Sequence[str]
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    name str
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    parameters Mapping[str, Mapping[str, str]]
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgres_major_version float
    The PostgreSQL major version for the shard configuration profile
    postgres_minor_version float
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas float
    The new number of replicas for the shard configuration profile
    storage NekiConfigurationProfileStorageArgs
    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.
    clusterSize String
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    extensions List<String>
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    name String
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    parameters Map<Map<String>>
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgresMajorVersion Number
    The PostgreSQL major version for the shard configuration profile
    postgresMinorVersion Number
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas Number
    The new number of replicas for the shard configuration profile
    storage Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the default shard configuration profile
    ShardCount double
    The number of shards using this configuration profile
    State string
    The current state of the shard configuration profile
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the default shard configuration profile
    ShardCount float64
    The number of shards using this configuration profile
    State string
    The current state of the shard configuration profile
    id string
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the default shard configuration profile
    shard_count number
    The number of shards using this configuration profile
    state string
    The current state of the shard configuration profile
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the default shard configuration profile
    shardCount Double
    The number of shards using this configuration profile
    state String
    The current state of the shard configuration profile
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Whether this is the default shard configuration profile
    shardCount number
    The number of shards using this configuration profile
    state string
    The current state of the shard configuration profile
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the default shard configuration profile
    shard_count float
    The number of shards using this configuration profile
    state str
    The current state of the shard configuration profile
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the default shard configuration profile
    shardCount Number
    The number of shards using this configuration profile
    state String
    The current state of the shard configuration profile

    Look up Existing NekiConfigurationProfile Resource

    Get an existing NekiConfigurationProfile 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?: NekiConfigurationProfileState, opts?: CustomResourceOptions): NekiConfigurationProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        branch: Optional[str] = None,
        cluster_size: Optional[str] = None,
        database: Optional[str] = None,
        extensions: Optional[Sequence[str]] = None,
        is_default: Optional[bool] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
        postgres_major_version: Optional[float] = None,
        postgres_minor_version: Optional[float] = None,
        replicas: Optional[float] = None,
        shard_count: Optional[float] = None,
        state: Optional[str] = None,
        storage: Optional[NekiConfigurationProfileStorageArgs] = None) -> NekiConfigurationProfile
    func GetNekiConfigurationProfile(ctx *Context, name string, id IDInput, state *NekiConfigurationProfileState, opts ...ResourceOption) (*NekiConfigurationProfile, error)
    public static NekiConfigurationProfile Get(string name, Input<string> id, NekiConfigurationProfileState? state, CustomResourceOptions? opts = null)
    public static NekiConfigurationProfile get(String name, Output<String> id, NekiConfigurationProfileState state, CustomResourceOptions options)
    resources:  _:    type: planetscale:NekiConfigurationProfile    get:      id: ${id}
    import {
  to = planetscale_neki_configuration_profile.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:
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    ClusterSize string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    Database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    Extensions List<string>
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    IsDefault bool
    Whether this is the default shard configuration profile
    Name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    Parameters Dictionary<string, ImmutableDictionary<string, string>>
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    PostgresMajorVersion double
    The PostgreSQL major version for the shard configuration profile
    PostgresMinorVersion double
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    Replicas double
    The new number of replicas for the shard configuration profile
    ShardCount double
    The number of shards using this configuration profile
    State string
    The current state of the shard configuration profile
    Storage NekiConfigurationProfileStorage
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    ClusterSize string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    Database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    Extensions []string
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    IsDefault bool
    Whether this is the default shard configuration profile
    Name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    Organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    Parameters map[string]map[string]string
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    PostgresMajorVersion float64
    The PostgreSQL major version for the shard configuration profile
    PostgresMinorVersion float64
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    Replicas float64
    The new number of replicas for the shard configuration profile
    ShardCount float64
    The number of shards using this configuration profile
    State string
    The current state of the shard configuration profile
    Storage NekiConfigurationProfileStorageArgs
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    cluster_size string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    extensions list(string)
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    is_default bool
    Whether this is the default shard configuration profile
    name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    parameters map(map(string))
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgres_major_version number
    The PostgreSQL major version for the shard configuration profile
    postgres_minor_version number
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas number
    The new number of replicas for the shard 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. Requires replacement if changed.
    clusterSize String
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    database String
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    extensions List<String>
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    isDefault Boolean
    Whether this is the default shard configuration profile
    name String
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    parameters Map<String,Map<String,String>>
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgresMajorVersion Double
    The PostgreSQL major version for the shard configuration profile
    postgresMinorVersion Double
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas Double
    The new number of replicas for the shard configuration profile
    shardCount Double
    The number of shards using this configuration profile
    state String
    The current state of the shard configuration profile
    storage NekiConfigurationProfileStorage
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    clusterSize string
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    database string
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    extensions string[]
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    isDefault boolean
    Whether this is the default shard configuration profile
    name string
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    organization string
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    parameters {[key: string]: {[key: string]: string}}
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgresMajorVersion number
    The PostgreSQL major version for the shard configuration profile
    postgresMinorVersion number
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas number
    The new number of replicas for the shard configuration profile
    shardCount number
    The number of shards using this configuration profile
    state string
    The current state of the shard configuration profile
    storage NekiConfigurationProfileStorage
    branch str
    Branch name from list_branches. Example: main. Requires replacement if changed.
    cluster_size str
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    database str
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    extensions Sequence[str]
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    is_default bool
    Whether this is the default shard configuration profile
    name str
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    organization str
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    parameters Mapping[str, Mapping[str, str]]
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgres_major_version float
    The PostgreSQL major version for the shard configuration profile
    postgres_minor_version float
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas float
    The new number of replicas for the shard configuration profile
    shard_count float
    The number of shards using this configuration profile
    state str
    The current state of the shard configuration profile
    storage NekiConfigurationProfileStorageArgs
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    clusterSize String
    The database cluster size name for shards assigned to this profile. Updates in place through Neki maintenance.
    database String
    Database name slug from list_databases. Example: app-db. Requires replacement if changed.
    extensions List<String>
    Extensions to enable. This replaces the current set; omit it to leave them unchanged. Use an empty set to disable them. Do not combine this with sharedpreloadlibraries or sessionpreloadlibraries parameters.
    isDefault Boolean
    Whether this is the default shard configuration profile
    name String
    The profile name. The API uses this as the profile identity, so changing it requires replacement. Requires replacement if changed.
    organization String
    Organization name slug from list_organizations. Example: acme. Requires replacement if changed.
    parameters Map<Map<String>>
    Desired effective parameter values nested by namespace, e.g. { pgconf = { maxconnections = "200" } }. Configure extension settings using their pgconf keys (for example, pgconf.auto_explain.log_level). Omitted parameters reset to their defaults, except sharedpreloadlibraries and sessionpreload_libraries, which remain unchanged. To disable extensions, set extensions to an empty list or explicitly update the preload parameters.
    postgresMajorVersion Number
    The PostgreSQL major version for the shard configuration profile
    postgresMinorVersion Number
    The PostgreSQL minor version for the shard configuration profile. Requires postgresmajorversion when specified.
    replicas Number
    The new number of replicas for the shard 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

    NekiConfigurationProfileStorage, NekiConfigurationProfileStorageArgs

    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