Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel
  3. API Docs
  4. getEdgeConfig
Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.getEdgeConfig

Explore with Pulumi AI

Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel

Provides information about an existing Edge Config.

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

Example Usage

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

const example = vercel.getEdgeConfig({
    id: "ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
});
Copy
import pulumi
import pulumi_vercel as vercel

example = vercel.get_edge_config(id="ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vercel.LookupEdgeConfig(ctx, &vercel.LookupEdgeConfigArgs{
			Id: "ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vercel = Pulumi.Vercel;

return await Deployment.RunAsync(() => 
{
    var example = Vercel.GetEdgeConfig.Invoke(new()
    {
        Id = "ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.VercelFunctions;
import com.pulumi.vercel.inputs.GetEdgeConfigArgs;
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 example = VercelFunctions.getEdgeConfig(GetEdgeConfigArgs.builder()
            .id("ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      Function: vercel:getEdgeConfig
      Arguments:
        id: ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Copy

Using getEdgeConfig

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 getEdgeConfig(args: GetEdgeConfigArgs, opts?: InvokeOptions): Promise<GetEdgeConfigResult>
function getEdgeConfigOutput(args: GetEdgeConfigOutputArgs, opts?: InvokeOptions): Output<GetEdgeConfigResult>
Copy
def get_edge_config(id: Optional[str] = None,
                    team_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEdgeConfigResult
def get_edge_config_output(id: Optional[pulumi.Input[str]] = None,
                    team_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEdgeConfigResult]
Copy
func LookupEdgeConfig(ctx *Context, args *LookupEdgeConfigArgs, opts ...InvokeOption) (*LookupEdgeConfigResult, error)
func LookupEdgeConfigOutput(ctx *Context, args *LookupEdgeConfigOutputArgs, opts ...InvokeOption) LookupEdgeConfigResultOutput
Copy

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

public static class GetEdgeConfig 
{
    public static Task<GetEdgeConfigResult> InvokeAsync(GetEdgeConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetEdgeConfigResult> Invoke(GetEdgeConfigInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEdgeConfigResult> getEdgeConfig(GetEdgeConfigArgs args, InvokeOptions options)
public static Output<GetEdgeConfigResult> getEdgeConfig(GetEdgeConfigArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vercel:index/getEdgeConfig:getEdgeConfig
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
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.
Id This property is required. string
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
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.
id This property is required. String
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
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.
id This property is required. string
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
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.
id This property is required. str
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
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.
id This property is required. String
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
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.

getEdgeConfig Result

The following output properties are available:

Id string
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
Name string
The name/slug of the 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.
Id string
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
Name string
The name/slug of the 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.
id String
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
name String
The name/slug of the 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.
id string
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
name string
The name/slug of the 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.
id str
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
name str
The name/slug of the 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.
id String
The Edge Config ID to be retrieved. This can be found by navigating to the Edge Config in the Vercel UI and looking at the URL. It should begin with ecfg_.
name String
The name/slug of the 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.

Package Details

Repository
vercel pulumiverse/pulumi-vercel
License
Apache-2.0
Notes
This Pulumi package is based on the vercel Terraform Provider.
Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel