Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel Provider
  3. API Docs
  4. EdgeConfigItem
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.EdgeConfigItem

Explore with Pulumi AI

vercel logo
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse
pulumiverse/pulumi-vercel

    Provides an Edge Config Item.

    An Edge Config is a global data store that enables experimentation with feature flags, A/B testing, critical redirects, and more.

    An Edge Config Item is a value within an Edge Config.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vercel from "@pulumiverse/vercel";

const example = new vercel.EdgeConfig("example", {name: "example"});
const exampleEdgeConfigItem = new vercel.EdgeConfigItem("example", {
    edgeConfigId: example.id,
    key: "foobar",
    value: "baz",
});

    import pulumi
import pulumiverse_vercel as vercel

example = vercel.EdgeConfig("example", name="example")
example_edge_config_item = vercel.EdgeConfigItem("example",
    edge_config_id=example.id,
    key="foobar",
    value="baz")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-vercel/sdk/v3/go/vercel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := vercel.NewEdgeConfig(ctx, "example", &vercel.EdgeConfigArgs{
			Name: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewEdgeConfigItem(ctx, "example", &vercel.EdgeConfigItemArgs{
			EdgeConfigId: example.ID(),
			Key:          pulumi.String("foobar"),
			Value:        pulumi.String("baz"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vercel = Pulumiverse.Vercel;

return await Deployment.RunAsync(() => 
{
    var example = new Vercel.EdgeConfig("example", new()
    {
        Name = "example",
    });

    var exampleEdgeConfigItem = new Vercel.EdgeConfigItem("example", new()
    {
        EdgeConfigId = example.Id,
        Key = "foobar",
        Value = "baz",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.EdgeConfig;
import com.pulumi.vercel.EdgeConfigArgs;
import com.pulumi.vercel.EdgeConfigItem;
import com.pulumi.vercel.EdgeConfigItemArgs;
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) {
        var example = new EdgeConfig("example", EdgeConfigArgs.builder()
            .name("example")
            .build());

        var exampleEdgeConfigItem = new EdgeConfigItem("exampleEdgeConfigItem", EdgeConfigItemArgs.builder()
            .edgeConfigId(example.id())
            .key("foobar")
            .value("baz")
            .build());

    }
}

    resources:
  example:
    type: vercel:EdgeConfig
    properties:
      name: example
  exampleEdgeConfigItem:
    type: vercel:EdgeConfigItem
    name: example
    properties:
      edgeConfigId: ${example.id}
      key: foobar
      value: baz

    Create EdgeConfigItem Resource

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

    Constructor syntax

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

@overload
def EdgeConfigItem(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   edge_config_id: Optional[str] = None,
                   key: Optional[str] = None,
                   value: Optional[str] = None,
                   team_id: Optional[str] = None)
    func NewEdgeConfigItem(ctx *Context, name string, args EdgeConfigItemArgs, opts ...ResourceOption) (*EdgeConfigItem, error)
    public EdgeConfigItem(string name, EdgeConfigItemArgs args, CustomResourceOptions? opts = null)
    public EdgeConfigItem(String name, EdgeConfigItemArgs args)
public EdgeConfigItem(String name, EdgeConfigItemArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args EdgeConfigItemArgs
    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 EdgeConfigItemArgs
    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 EdgeConfigItemArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeConfigItemArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeConfigItemArgs
    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 edgeConfigItemResource = new Vercel.EdgeConfigItem("edgeConfigItemResource", new()
{
    EdgeConfigId = "string",
    Key = "string",
    Value = "string",
    TeamId = "string",
});

    example, err := vercel.NewEdgeConfigItem(ctx, "edgeConfigItemResource", &vercel.EdgeConfigItemArgs{
	EdgeConfigId: pulumi.String("string"),
	Key:          pulumi.String("string"),
	Value:        pulumi.String("string"),
	TeamId:       pulumi.String("string"),
})

    var edgeConfigItemResource = new EdgeConfigItem("edgeConfigItemResource", EdgeConfigItemArgs.builder()
    .edgeConfigId("string")
    .key("string")
    .value("string")
    .teamId("string")
    .build());

    edge_config_item_resource = vercel.EdgeConfigItem("edgeConfigItemResource",
    edge_config_id="string",
    key="string",
    value="string",
    team_id="string")

    const edgeConfigItemResource = new vercel.EdgeConfigItem("edgeConfigItemResource", {
    edgeConfigId: "string",
    key: "string",
    value: "string",
    teamId: "string",
});

    type: vercel:EdgeConfigItem
properties:
    edgeConfigId: string
    key: string
    teamId: string
    value: string

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

    EdgeConfigId string
    The ID of the Edge Config store.
    Key string
    The name of the key you want to add to or update within your Edge Config.
    Value string
    The value you want to assign to the key.
    TeamId string
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    EdgeConfigId string
    The ID of the Edge Config store.
    Key string
    The name of the key you want to add to or update within your Edge Config.
    Value string
    The value you want to assign to the key.
    TeamId string
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    edgeConfigId String
    The ID of the Edge Config store.
    key String
    The name of the key you want to add to or update within your Edge Config.
    value String
    The value you want to assign to the key.
    teamId String
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    edgeConfigId string
    The ID of the Edge Config store.
    key string
    The name of the key you want to add to or update within your Edge Config.
    value string
    The value you want to assign to the key.
    teamId string
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    edge_config_id str
    The ID of the Edge Config store.
    key str
    The name of the key you want to add to or update within your Edge Config.
    value str
    The value you want to assign to the key.
    team_id str
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    edgeConfigId String
    The ID of the Edge Config store.
    key String
    The name of the key you want to add to or update within your Edge Config.
    value String
    The value you want to assign to the key.
    teamId String
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EdgeConfigItem Resource

    Get an existing EdgeConfigItem 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?: EdgeConfigItemState, opts?: CustomResourceOptions): EdgeConfigItem
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        edge_config_id: Optional[str] = None,
        key: Optional[str] = None,
        team_id: Optional[str] = None,
        value: Optional[str] = None) -> EdgeConfigItem
    func GetEdgeConfigItem(ctx *Context, name string, id IDInput, state *EdgeConfigItemState, opts ...ResourceOption) (*EdgeConfigItem, error)
    public static EdgeConfigItem Get(string name, Input<string> id, EdgeConfigItemState? state, CustomResourceOptions? opts = null)
    public static EdgeConfigItem get(String name, Output<String> id, EdgeConfigItemState state, CustomResourceOptions options)
    resources:  _:    type: vercel:EdgeConfigItem    get:      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:
    EdgeConfigId string
    The ID of the Edge Config store.
    Key string
    The name of the key you want to add to or update within your Edge Config.
    TeamId string
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Value string
    The value you want to assign to the key.
    EdgeConfigId string
    The ID of the Edge Config store.
    Key string
    The name of the key you want to add to or update within your Edge Config.
    TeamId string
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Value string
    The value you want to assign to the key.
    edgeConfigId String
    The ID of the Edge Config store.
    key String
    The name of the key you want to add to or update within your Edge Config.
    teamId String
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    value String
    The value you want to assign to the key.
    edgeConfigId string
    The ID of the Edge Config store.
    key string
    The name of the key you want to add to or update within your Edge Config.
    teamId string
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    value string
    The value you want to assign to the key.
    edge_config_id str
    The ID of the Edge Config store.
    key str
    The name of the key you want to add to or update within your Edge Config.
    team_id str
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    value str
    The value you want to assign to the key.
    edgeConfigId String
    The ID of the Edge Config store.
    key String
    The name of the key you want to add to or update within your Edge Config.
    teamId String
    The ID of the team the Edge Config should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    value String
    The value you want to assign to the key.

    Import

    If importing into a personal account, or with a team configured on

    the provider, simply use the edge config id and the key of the item to import.

    • edge_config_id can be found by navigating to the Edge Config in the Vercel UI. It should begin with ecfg_.

    • key is the key of teh item to import.

    $ pulumi import vercel:index/edgeConfigItem:EdgeConfigItem example ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/example_key

    Alternatively, you can import via the team_id, edge_config_id and the key of the item to import.

    • team_id can be found in the team settings tab in the Vercel UI.

    • edge_config_id can be found by navigating to the Edge Config in the Vercel UI. It should begin with ecfg_.

    • key is the key of the item to import.

    $ pulumi import vercel:index/edgeConfigItem:EdgeConfigItem example team_xxxxxxxxxxxxxxxxxxxxxxxx/ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/example_key

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

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse
    pulumiverse/pulumi-vercel