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

planetscale.NekiSidecar

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

    NekiSidecar Resource

    Create NekiSidecar Resource

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

    Constructor syntax

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

@overload
def NekiSidecar(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                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)
    func NewNekiSidecar(ctx *Context, name string, args NekiSidecarArgs, opts ...ResourceOption) (*NekiSidecar, error)
    public NekiSidecar(string name, NekiSidecarArgs args, CustomResourceOptions? opts = null)
    public NekiSidecar(String name, NekiSidecarArgs args)
public NekiSidecar(String name, NekiSidecarArgs args, CustomResourceOptions options)

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


    resource "planetscale_neki_sidecar" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args NekiSidecarArgs
    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 NekiSidecarArgs
    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 NekiSidecarArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NekiSidecarArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NekiSidecarArgs
    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 nekiSidecarResource = new Planetscale.NekiSidecar("nekiSidecarResource", new()
{
    Branch = "string",
    ConfigurationProfile = "string",
    Database = "string",
    Organization = "string",
    Parameters = 
    {
        { "string", new InputMap<string>
        {
            { "string", "string" },
        } },
    },
});

    example, err := planetscale.NewNekiSidecar(ctx, "nekiSidecarResource", &planetscale.NekiSidecarArgs{
	Branch:               pulumi.String("string"),
	ConfigurationProfile: pulumi.String("string"),
	Database:             pulumi.String("string"),
	Organization:         pulumi.String("string"),
	Parameters: pulumi.StringMapMap{
		"string": pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
})

    resource "planetscale_neki_sidecar" "nekiSidecarResource" {
  lifecycle {
    create_before_destroy = true
  }
  branch                = "string"
  configuration_profile = "string"
  database              = "string"
  organization          = "string"
  parameters = {
    "string" = {
      "string" = "string"
    }
  }
}

    var nekiSidecarResource = new NekiSidecar("nekiSidecarResource", NekiSidecarArgs.builder()
    .branch("string")
    .configurationProfile("string")
    .database("string")
    .organization("string")
    .parameters(Map.of("string", Map.of("string", "string")))
    .build());

    neki_sidecar_resource = planetscale.NekiSidecar("nekiSidecarResource",
    branch="string",
    configuration_profile="string",
    database="string",
    organization="string",
    parameters={
        "string": {
            "string": "string",
        },
    })

    const nekiSidecarResource = new planetscale.NekiSidecar("nekiSidecarResource", {
    branch: "string",
    configurationProfile: "string",
    database: "string",
    organization: "string",
    parameters: {
        string: {
            string: "string",
        },
    },
});

    type: planetscale:NekiSidecar
properties:
    branch: string
    configurationProfile: string
    database: string
    organization: string
    parameters:
        string:
            string: string

    NekiSidecar 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 NekiSidecar resource accepts the following input properties:

    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    ConfigurationProfile string
    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.
    Parameters Dictionary<string, ImmutableDictionary<string, string>>
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    ConfigurationProfile string
    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.
    Parameters map[string]map[string]string
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configuration_profile string
    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.
    parameters map(map(string))
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configurationProfile String
    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.
    parameters Map<String,Map<String,String>>
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configurationProfile string
    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.
    parameters {[key: string]: {[key: string]: string}}
    branch str
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configuration_profile str
    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.
    parameters Mapping[str, Mapping[str, str]]
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configurationProfile String
    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.
    parameters Map<Map<String>>

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the sidecar
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of the sidecar
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the sidecar
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the sidecar
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The current state of the sidecar
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The current state of the sidecar
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The current state of the sidecar

    Look up Existing NekiSidecar Resource

    Get an existing NekiSidecar 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?: NekiSidecarState, opts?: CustomResourceOptions): NekiSidecar
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        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,
        state: Optional[str] = None) -> NekiSidecar
    func GetNekiSidecar(ctx *Context, name string, id IDInput, state *NekiSidecarState, opts ...ResourceOption) (*NekiSidecar, error)
    public static NekiSidecar Get(string name, Input<string> id, NekiSidecarState? state, CustomResourceOptions? opts = null)
    public static NekiSidecar get(String name, Output<String> id, NekiSidecarState state, CustomResourceOptions options)
    resources:  _:    type: planetscale:NekiSidecar    get:      id: ${id}
    import {
  to = planetscale_neki_sidecar.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.
    ConfigurationProfile string
    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.
    Parameters Dictionary<string, ImmutableDictionary<string, string>>
    State string
    The current state of the sidecar
    Branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    ConfigurationProfile string
    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.
    Parameters map[string]map[string]string
    State string
    The current state of the sidecar
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configuration_profile string
    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.
    parameters map(map(string))
    state string
    The current state of the sidecar
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configurationProfile String
    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.
    parameters Map<String,Map<String,String>>
    state String
    The current state of the sidecar
    branch string
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configurationProfile string
    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.
    parameters {[key: string]: {[key: string]: string}}
    state string
    The current state of the sidecar
    branch str
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configuration_profile str
    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.
    parameters Mapping[str, Mapping[str, str]]
    state str
    The current state of the sidecar
    branch String
    Branch name from list_branches. Example: main. Requires replacement if changed.
    configurationProfile String
    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.
    parameters Map<Map<String>>
    state String
    The current state of the sidecar

    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_sidecar.my_planetscale_neki_sidecar

    id = jsonencode({

    branch                = "..."

configuration_profile = "..."

database              = "..."

organization          = "..."

    })

    }

    The pulumi import command can be used, for example:

    $ pulumi import planetscale:index/nekiSidecar:NekiSidecar my_planetscale_neki_sidecar '{"branch": "...", "configuration_profile": "...", "database": "...", "organization": "..."}'

    To learn more about importing existing cloud resources, see Importing resources.

    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