1. Packages
  2. Vercel
  3. API Docs
  4. EdgeConfig
Vercel v1.15.0 published on Wednesday, Mar 19, 2025 by Pulumiverse

vercel.EdgeConfig

Explore with Pulumi AI

vercel logo
Vercel v1.15.0 published on Wednesday, Mar 19, 2025 by Pulumiverse

    Create EdgeConfig Resource

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

    Constructor syntax

    new EdgeConfig(name: string, args?: EdgeConfigArgs, opts?: CustomResourceOptions);
    @overload
    def EdgeConfig(resource_name: str,
                   args: Optional[EdgeConfigArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def EdgeConfig(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   name: Optional[str] = None,
                   team_id: Optional[str] = None)
    func NewEdgeConfig(ctx *Context, name string, args *EdgeConfigArgs, opts ...ResourceOption) (*EdgeConfig, error)
    public EdgeConfig(string name, EdgeConfigArgs? args = null, CustomResourceOptions? opts = null)
    public EdgeConfig(String name, EdgeConfigArgs args)
    public EdgeConfig(String name, EdgeConfigArgs args, CustomResourceOptions options)
    
    type: vercel:EdgeConfig
    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 EdgeConfigArgs
    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 EdgeConfigArgs
    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 EdgeConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeConfigArgs
    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 edgeConfigResource = new Vercel.EdgeConfig("edgeConfigResource", new()
    {
        Name = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewEdgeConfig(ctx, "edgeConfigResource", &vercel.EdgeConfigArgs{
    	Name:   pulumi.String("string"),
    	TeamId: pulumi.String("string"),
    })
    
    var edgeConfigResource = new EdgeConfig("edgeConfigResource", EdgeConfigArgs.builder()
        .name("string")
        .teamId("string")
        .build());
    
    edge_config_resource = vercel.EdgeConfig("edgeConfigResource",
        name="string",
        team_id="string")
    
    const edgeConfigResource = new vercel.EdgeConfig("edgeConfigResource", {
        name: "string",
        teamId: "string",
    });
    
    type: vercel:EdgeConfig
    properties:
        name: string
        teamId: string
    

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

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EdgeConfig 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 EdgeConfig Resource

    Get an existing EdgeConfig 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?: EdgeConfigState, opts?: CustomResourceOptions): EdgeConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            team_id: Optional[str] = None) -> EdgeConfig
    func GetEdgeConfig(ctx *Context, name string, id IDInput, state *EdgeConfigState, opts ...ResourceOption) (*EdgeConfig, error)
    public static EdgeConfig Get(string name, Input<string> id, EdgeConfigState? state, CustomResourceOptions? opts = null)
    public static EdgeConfig get(String name, Output<String> id, EdgeConfigState state, CustomResourceOptions options)
    resources:  _:    type: vercel:EdgeConfig    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:
    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.
    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.
    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.
    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.
    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.
    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 logo
    Vercel v1.15.0 published on Wednesday, Mar 19, 2025 by Pulumiverse