1. Packages
  2. Vercel
  3. API Docs
  4. EdgeConfigSchema
Vercel v1.11.0 published on Thursday, May 23, 2024 by Pulumiverse

vercel.EdgeConfigSchema

Explore with Pulumi AI

vercel logo
Vercel v1.11.0 published on Thursday, May 23, 2024 by Pulumiverse

    An Edge Config Schema provides an existing Edge Config with a JSON schema. Use schema protection to prevent unexpected updates that may cause bugs or downtime.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    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.EdgeConfigSchema;
    import com.pulumi.vercel.EdgeConfigSchemaArgs;
    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 exampleEdgeConfig = new EdgeConfig("exampleEdgeConfig");
    
            var exampleEdgeConfigSchema = new EdgeConfigSchema("exampleEdgeConfigSchema", EdgeConfigSchemaArgs.builder()        
                .id(exampleEdgeConfig.id())
                .definition("""
    {
      "title": "Greeting",
      "type": "object",
      "properties": {
        "greeting": {
          "description": "A friendly greeting",
          "type": "string"
        }
      }
    }
                """)
                .build());
    
        }
    }
    
    resources:
      exampleEdgeConfig:
        type: vercel:EdgeConfig
      exampleEdgeConfigSchema:
        type: vercel:EdgeConfigSchema
        properties:
          id: ${exampleEdgeConfig.id}
          definition: |
            {
              "title": "Greeting",
              "type": "object",
              "properties": {
                "greeting": {
                  "description": "A friendly greeting",
                  "type": "string"
                }
              }
            }        
    

    Create EdgeConfigSchema Resource

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

    Constructor syntax

    new EdgeConfigSchema(name: string, args: EdgeConfigSchemaArgs, opts?: CustomResourceOptions);
    @overload
    def EdgeConfigSchema(resource_name: str,
                         args: EdgeConfigSchemaArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def EdgeConfigSchema(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         definition: Optional[str] = None,
                         team_id: Optional[str] = None)
    func NewEdgeConfigSchema(ctx *Context, name string, args EdgeConfigSchemaArgs, opts ...ResourceOption) (*EdgeConfigSchema, error)
    public EdgeConfigSchema(string name, EdgeConfigSchemaArgs args, CustomResourceOptions? opts = null)
    public EdgeConfigSchema(String name, EdgeConfigSchemaArgs args)
    public EdgeConfigSchema(String name, EdgeConfigSchemaArgs args, CustomResourceOptions options)
    
    type: vercel:EdgeConfigSchema
    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 EdgeConfigSchemaArgs
    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 EdgeConfigSchemaArgs
    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 EdgeConfigSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EdgeConfigSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EdgeConfigSchemaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var edgeConfigSchemaResource = new Vercel.EdgeConfigSchema("edgeConfigSchemaResource", new()
    {
        Definition = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewEdgeConfigSchema(ctx, "edgeConfigSchemaResource", &vercel.EdgeConfigSchemaArgs{
    	Definition: pulumi.String("string"),
    	TeamId:     pulumi.String("string"),
    })
    
    var edgeConfigSchemaResource = new EdgeConfigSchema("edgeConfigSchemaResource", EdgeConfigSchemaArgs.builder()        
        .definition("string")
        .teamId("string")
        .build());
    
    edge_config_schema_resource = vercel.EdgeConfigSchema("edgeConfigSchemaResource",
        definition="string",
        team_id="string")
    
    const edgeConfigSchemaResource = new vercel.EdgeConfigSchema("edgeConfigSchemaResource", {
        definition: "string",
        teamId: "string",
    });
    
    type: vercel:EdgeConfigSchema
    properties:
        definition: string
        teamId: string
    

    EdgeConfigSchema Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EdgeConfigSchema resource accepts the following input properties:

    Definition string
    A JSON schema that will be used to validate data in 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.
    Definition string
    A JSON schema that will be used to validate data in 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.
    definition String
    A JSON schema that will be used to validate data in 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.
    definition string
    A JSON schema that will be used to validate data in 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.
    definition str
    A JSON schema that will be used to validate data in 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.
    definition String
    A JSON schema that will be used to validate data in 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 EdgeConfigSchema 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 EdgeConfigSchema Resource

    Get an existing EdgeConfigSchema 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?: EdgeConfigSchemaState, opts?: CustomResourceOptions): EdgeConfigSchema
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            definition: Optional[str] = None,
            team_id: Optional[str] = None) -> EdgeConfigSchema
    func GetEdgeConfigSchema(ctx *Context, name string, id IDInput, state *EdgeConfigSchemaState, opts ...ResourceOption) (*EdgeConfigSchema, error)
    public static EdgeConfigSchema Get(string name, Input<string> id, EdgeConfigSchemaState? state, CustomResourceOptions? opts = null)
    public static EdgeConfigSchema get(String name, Output<String> id, EdgeConfigSchemaState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Definition string
    A JSON schema that will be used to validate data in 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.
    Definition string
    A JSON schema that will be used to validate data in 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.
    definition String
    A JSON schema that will be used to validate data in 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.
    definition string
    A JSON schema that will be used to validate data in 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.
    definition str
    A JSON schema that will be used to validate data in 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.
    definition String
    A JSON schema that will be used to validate data in 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.

    Import

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

    the provider, simply use the edge config id.

    • edge_config_id can be found by navigating to the Edge Config in the Vercel UI. It should begin with ecfg_.
    $ pulumi import vercel:index/edgeConfigSchema:EdgeConfigSchema example ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    Alternatively, you can import via the team_id and edge_config_id.

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

    $ pulumi import vercel:index/edgeConfigSchema:EdgeConfigSchema example team_xxxxxxxxxxxxxxxxxxxxxxxx/ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    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 v1.11.0 published on Thursday, May 23, 2024 by Pulumiverse