Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
published on Friday, Sep 18, 2026 by planetscale
Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
published on Friday, Sep 18, 2026 by planetscale
NekiAdmin DataSource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";
const myNekiadmin = planetscale.getNekiAdmin({
branch: "...my_branch...",
database: "...my_database...",
organization: "...my_organization...",
parameters: {
key: {},
},
});
import pulumi
import pulumi_planetscale as planetscale
my_nekiadmin = planetscale.get_neki_admin(branch="...my_branch...",
database="...my_database...",
organization="...my_organization...",
parameters={
"key": {},
})
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.LookupNekiAdmin(ctx, &planetscale.LookupNekiAdminArgs{
Branch: "...my_branch...",
Database: "...my_database...",
Organization: "...my_organization...",
Parameters: map[string]interface{}{
"key": map[string]interface{}{},
},
}, 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 myNekiadmin = Planetscale.GetNekiAdmin.Invoke(new()
{
Branch = "...my_branch...",
Database = "...my_database...",
Organization = "...my_organization...",
Parameters =
{
{ "key", null },
},
});
});
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.GetNekiAdminArgs;
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 myNekiadmin = PlanetscaleFunctions.getNekiAdmin(GetNekiAdminArgs.builder()
.branch("...my_branch...")
.database("...my_database...")
.organization("...my_organization...")
.parameters(Map.of("key", Map.ofEntries(
)))
.build());
}
}
variables:
myNekiadmin:
fn::invoke:
function: planetscale:getNekiAdmin
arguments:
branch: '...my_branch...'
database: '...my_database...'
organization: '...my_organization...'
parameters:
key: {}
Example coming soon!
Using getNekiAdmin
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 getNekiAdmin(args: GetNekiAdminArgs, opts?: InvokeOptions): Promise<GetNekiAdminResult>
function getNekiAdminOutput(args: GetNekiAdminOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiAdminResult>def get_neki_admin(branch: Optional[str] = None,
database: Optional[str] = None,
organization: Optional[str] = None,
parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
opts: Optional[InvokeOptions] = None) -> GetNekiAdminResult
def get_neki_admin_output(branch: pulumi.Input[Optional[str]] = None,
database: 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[GetNekiAdminResult]func LookupNekiAdmin(ctx *Context, args *LookupNekiAdminArgs, opts ...InvokeOption) (*LookupNekiAdminResult, error)
func LookupNekiAdminOutput(ctx *Context, args *LookupNekiAdminOutputArgs, opts ...InvokeOption) LookupNekiAdminResultOutput> Note: This function is named LookupNekiAdmin in the Go SDK.
public static class GetNekiAdmin
{
public static Task<GetNekiAdminResult> InvokeAsync(GetNekiAdminArgs args, InvokeOptions? opts = null)
public static Output<GetNekiAdminResult> Invoke(GetNekiAdminInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetNekiAdminResult> Invoke(GetNekiAdminInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetNekiAdminResult> getNekiAdmin(GetNekiAdminArgs args, InvokeOptions options)
public static Output<GetNekiAdminResult> getNekiAdmin(GetNekiAdminArgs args, InvokeOptions options)
public static Output<GetNekiAdminResult> getNekiAdmin(GetNekiAdminArgs args, InvokeOutputOptions options)
fn::invoke:
function: planetscale:index/getNekiAdmin:getNekiAdmin
arguments:
# arguments dictionarydata "planetscale_get_neki_admin" "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. - Parameters
Dictionary<string, Immutable
Dictionary<string, string>> - Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- 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. - Parameters map[string]map[string]string
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- 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. - parameters map(map(string))
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- 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. - parameters Map<String,Map<String,String>>
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- 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. - parameters {[key: string]: {[key: string]: string}}
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- 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. - parameters Mapping[str, Mapping[str, str]]
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- 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. - parameters Map<Map<String>>
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
getNekiAdmin Result
The following output properties are available:
- Admin
Size string - The admin size SKU name
- Branch string
- Branch name from
list_branches. Example:main. - Database string
- Database name slug from
list_databases. Example:app-db. - Id string
- The ID of the admin
- Organization string
- Organization name slug from
list_organizations. Example:acme. - Parameters
Dictionary<string, Immutable
Dictionary<string, string>> - Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- State string
- The current state of the admin
- Admin
Size string - The admin size SKU name
- Branch string
- Branch name from
list_branches. Example:main. - Database string
- Database name slug from
list_databases. Example:app-db. - Id string
- The ID of the admin
- Organization string
- Organization name slug from
list_organizations. Example:acme. - Parameters map[string]map[string]string
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- State string
- The current state of the admin
- admin_
size string - The admin size SKU name
- branch string
- Branch name from
list_branches. Example:main. - database string
- Database name slug from
list_databases. Example:app-db. - id string
- The ID of the admin
- organization string
- Organization name slug from
list_organizations. Example:acme. - parameters map(map(string))
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- state string
- The current state of the admin
- admin
Size String - The admin size SKU name
- branch String
- Branch name from
list_branches. Example:main. - database String
- Database name slug from
list_databases. Example:app-db. - id String
- The ID of the admin
- organization String
- Organization name slug from
list_organizations. Example:acme. - parameters Map<String,Map<String,String>>
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- state String
- The current state of the admin
- admin
Size string - The admin size SKU name
- branch string
- Branch name from
list_branches. Example:main. - database string
- Database name slug from
list_databases. Example:app-db. - id string
- The ID of the admin
- organization string
- Organization name slug from
list_organizations. Example:acme. - parameters {[key: string]: {[key: string]: string}}
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- state string
- The current state of the admin
- admin_
size str - The admin size SKU name
- branch str
- Branch name from
list_branches. Example:main. - database str
- Database name slug from
list_databases. Example:app-db. - id str
- The ID of the admin
- organization str
- Organization name slug from
list_organizations. Example:acme. - parameters Mapping[str, Mapping[str, str]]
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- state str
- The current state of the admin
- admin
Size String - The admin size SKU name
- branch String
- Branch name from
list_branches. Example:main. - database String
- Database name slug from
list_databases. Example:app-db. - id String
- The ID of the admin
- organization String
- Organization name slug from
list_organizations. Example:acme. - parameters Map<Map<String>>
- Managed effective admin parameter values nested by namespace. Remote non-default values are adopted during reads.
- state String
- The current state of the admin
Package Details
- Repository
- planetscale planetscale/terraform-provider-planetscale
- License
- Notes
- This Pulumi package is based on the
planetscaleTerraform Provider.
Viewing docs for planetscale 1.11.0
published on Friday, Sep 18, 2026 by planetscale
published on Friday, Sep 18, 2026 by planetscale