getNekiSidecar

planetscale 1.11.0, Sep 18 26

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

planetscale/terraform-provider-planetscale

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

planetscale/terraform-provider-planetscale

Example Usage

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

const myNekisidecar = planetscale.getNekiSidecar({
    branch: "...my_branch...",
    configurationProfile: "...my_configuration_profile...",
    database: "...my_database...",
    organization: "...my_organization...",
    parameters: {
        key: {},
    },
});

import pulumi
import pulumi_planetscale as planetscale

my_nekisidecar = planetscale.get_neki_sidecar(branch="...my_branch...",
    configuration_profile="...my_configuration_profile...",
    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.LookupNekiSidecar(ctx, &planetscale.LookupNekiSidecarArgs{
			Branch:               "...my_branch...",
			ConfigurationProfile: "...my_configuration_profile...",
			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 myNekisidecar = Planetscale.GetNekiSidecar.Invoke(new()
    {
        Branch = "...my_branch...",
        ConfigurationProfile = "...my_configuration_profile...",
        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.GetNekiSidecarArgs;
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 myNekisidecar = PlanetscaleFunctions.getNekiSidecar(GetNekiSidecarArgs.builder()
            .branch("...my_branch...")
            .configurationProfile("...my_configuration_profile...")
            .database("...my_database...")
            .organization("...my_organization...")
            .parameters(Map.of("key", Map.ofEntries(
            )))
            .build());

    }
}

variables:
  myNekisidecar:
    fn::invoke:
      function: planetscale:getNekiSidecar
      arguments:
        branch: '...my_branch...'
        configurationProfile: '...my_configuration_profile...'
        database: '...my_database...'
        organization: '...my_organization...'
        parameters:
          key: {}

Example coming soon!

Using getNekiSidecar

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 getNekiSidecar(args: GetNekiSidecarArgs, opts?: InvokeOptions): Promise<GetNekiSidecarResult>
function getNekiSidecarOutput(args: GetNekiSidecarOutputArgs, opts?: InvokeOutputOptions): Output<GetNekiSidecarResult>

def get_neki_sidecar(branch: Optional[str] = None,
                     configuration_profile: Optional[str] = None,
                     database: Optional[str] = None,
                     organization: Optional[str] = None,
                     parameters: Optional[Mapping[str, Mapping[str, str]]] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNekiSidecarResult
def get_neki_sidecar_output(branch: pulumi.Input[Optional[str]] = None,
                     configuration_profile: 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[GetNekiSidecarResult]

func LookupNekiSidecar(ctx *Context, args *LookupNekiSidecarArgs, opts ...InvokeOption) (*LookupNekiSidecarResult, error)
func LookupNekiSidecarOutput(ctx *Context, args *LookupNekiSidecarOutputArgs, opts ...InvokeOption) LookupNekiSidecarResultOutput

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

public static class GetNekiSidecar 
{
    public static Task<GetNekiSidecarResult> InvokeAsync(GetNekiSidecarArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiSidecarResult> Invoke(GetNekiSidecarInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetNekiSidecarResult> Invoke(GetNekiSidecarInvokeArgs args, InvokeOutputOptions opts)
}

public static CompletableFuture<GetNekiSidecarResult> getNekiSidecar(GetNekiSidecarArgs args, InvokeOptions options)
public static Output<GetNekiSidecarResult> getNekiSidecar(GetNekiSidecarArgs args, InvokeOptions options)
public static Output<GetNekiSidecarResult> getNekiSidecar(GetNekiSidecarArgs args, InvokeOutputOptions options)

fn::invoke:
  function: planetscale:index/getNekiSidecar:getNekiSidecar
  arguments:
    # arguments dictionary

data "planetscale_get_neki_sidecar" "name" {
    # arguments
}

The following arguments are supported:

Branch string: Branch name from list_branches. Example: main.
ConfigurationProfile string: The name of the shard configuration profile the sidecar belongs to
Database string: Database name slug from list_databases. Example: app-db.
Organization string: Organization name slug from list_organizations. Example: acme.
Parameters Dictionary<string, ImmutableDictionary<string, string>>: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

Branch string: Branch name from list_branches. Example: main.
ConfigurationProfile string: The name of the shard configuration profile the sidecar belongs to
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 sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

branch string: Branch name from list_branches. Example: main.
configuration_profile string: The name of the shard configuration profile the sidecar belongs to
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 sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

branch String: Branch name from list_branches. Example: main.
configurationProfile String: The name of the shard configuration profile the sidecar belongs to
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 sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

branch string: Branch name from list_branches. Example: main.
configurationProfile string: The name of the shard configuration profile the sidecar belongs to
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 sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

branch str: Branch name from list_branches. Example: main.
configuration_profile str: The name of the shard configuration profile the sidecar belongs to
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 sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

branch String: Branch name from list_branches. Example: main.
configurationProfile String: The name of the shard configuration profile the sidecar belongs to
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 sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.

getNekiSidecar Result

The following output properties are available:

Branch string: Branch name from list_branches. Example: main.
ConfigurationProfile string: The name of the shard configuration profile the sidecar belongs to
Database string: Database name slug from list_databases. Example: app-db.
Id string: The ID of the sidecar
Organization string: Organization name slug from list_organizations. Example: acme.
Parameters Dictionary<string, ImmutableDictionary<string, string>>: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
State string: The current state of the sidecar

Branch string: Branch name from list_branches. Example: main.
ConfigurationProfile string: The name of the shard configuration profile the sidecar belongs to
Database string: Database name slug from list_databases. Example: app-db.
Id string: The ID of the sidecar
Organization string: Organization name slug from list_organizations. Example: acme.
Parameters map[string]map[string]string: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
State string: The current state of the sidecar

branch string: Branch name from list_branches. Example: main.
configuration_profile string: The name of the shard configuration profile the sidecar belongs to
database string: Database name slug from list_databases. Example: app-db.
id string: The ID of the sidecar
organization string: Organization name slug from list_organizations. Example: acme.
parameters map(map(string)): Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
state string: The current state of the sidecar

branch String: Branch name from list_branches. Example: main.
configurationProfile String: The name of the shard configuration profile the sidecar belongs to
database String: Database name slug from list_databases. Example: app-db.
id String: The ID of the sidecar
organization String: Organization name slug from list_organizations. Example: acme.
parameters Map<String,Map<String,String>>: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
state String: The current state of the sidecar

branch string: Branch name from list_branches. Example: main.
configurationProfile string: The name of the shard configuration profile the sidecar belongs to
database string: Database name slug from list_databases. Example: app-db.
id string: The ID of the sidecar
organization string: Organization name slug from list_organizations. Example: acme.
parameters {[key: string]: {[key: string]: string}}: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
state string: The current state of the sidecar

branch str: Branch name from list_branches. Example: main.
configuration_profile str: The name of the shard configuration profile the sidecar belongs to
database str: Database name slug from list_databases. Example: app-db.
id str: The ID of the sidecar
organization str: Organization name slug from list_organizations. Example: acme.
parameters Mapping[str, Mapping[str, str]]: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
state str: The current state of the sidecar

branch String: Branch name from list_branches. Example: main.
configurationProfile String: The name of the shard configuration profile the sidecar belongs to
database String: Database name slug from list_databases. Example: app-db.
id String: The ID of the sidecar
organization String: Organization name slug from list_organizations. Example: acme.
parameters Map<Map<String>>: Managed effective sidecar parameter values nested by namespace. Remote non-default values are adopted during reads.
state String: The current state of the sidecar

Package Details

Repository: planetscale planetscale/terraform-provider-planetscale
License
Notes: This Pulumi package is based on the planetscale Terraform Provider.

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

Schema (JSON)

planetscale/terraform-provider-planetscale

planetscale.getNekiSidecar

On this page

On this page

Example Usage

Using getNekiSidecar

getNekiSidecar Result

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

planetscale.getNekiSidecar

On this page

On this page

Example Usage

Using getNekiSidecar

getNekiSidecar Result

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.