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

vercel.getEdgeConfigSchema

Explore with Pulumi AI

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

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

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

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

test = vercel.get_edge_config_schema(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.LookupEdgeConfigSchema(ctx, &vercel.LookupEdgeConfigSchemaArgs{
			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 test = Vercel.GetEdgeConfigSchema.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.GetEdgeConfigSchemaArgs;
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 test = VercelFunctions.getEdgeConfigSchema(GetEdgeConfigSchemaArgs.builder()
            .id("ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx")
            .build());

    }
}
Copy
variables:
  test:
    fn::invoke:
      Function: vercel:getEdgeConfigSchema
      Arguments:
        id: ecfg_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
Copy

Using getEdgeConfigSchema

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 getEdgeConfigSchema(args: GetEdgeConfigSchemaArgs, opts?: InvokeOptions): Promise<GetEdgeConfigSchemaResult>
function getEdgeConfigSchemaOutput(args: GetEdgeConfigSchemaOutputArgs, opts?: InvokeOptions): Output<GetEdgeConfigSchemaResult>
Copy
def get_edge_config_schema(id: Optional[str] = None,
                           team_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetEdgeConfigSchemaResult
def get_edge_config_schema_output(id: Optional[pulumi.Input[str]] = None,
                           team_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetEdgeConfigSchemaResult]
Copy
func LookupEdgeConfigSchema(ctx *Context, args *LookupEdgeConfigSchemaArgs, opts ...InvokeOption) (*LookupEdgeConfigSchemaResult, error)
func LookupEdgeConfigSchemaOutput(ctx *Context, args *LookupEdgeConfigSchemaOutputArgs, opts ...InvokeOption) LookupEdgeConfigSchemaResultOutput
Copy

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

public static class GetEdgeConfigSchema 
{
    public static Task<GetEdgeConfigSchemaResult> InvokeAsync(GetEdgeConfigSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetEdgeConfigSchemaResult> Invoke(GetEdgeConfigSchemaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEdgeConfigSchemaResult> getEdgeConfigSchema(GetEdgeConfigSchemaArgs args, InvokeOptions options)
public static Output<GetEdgeConfigSchemaResult> getEdgeConfigSchema(GetEdgeConfigSchemaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vercel:index/getEdgeConfigSchema:getEdgeConfigSchema
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Id This property is required. string
The ID of the Edge Config that the schema should be for.
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 ID of the Edge Config that the schema should be for.
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 ID of the Edge Config that the schema should be for.
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 ID of the Edge Config that the schema should be for.
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 ID of the Edge Config that the schema should be for.
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 ID of the Edge Config that the schema should be for.
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.

getEdgeConfigSchema Result

The following output properties are available:

Definition string
A JSON schema that will be used to validate data in the Edge Config.
Id string
The ID of the Edge Config that the schema should be for.
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.
Id string
The ID of the Edge Config that the schema should be for.
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.
id String
The ID of the Edge Config that the schema should be for.
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.
id string
The ID of the Edge Config that the schema should be for.
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.
id str
The ID of the Edge Config that the schema should be for.
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.
id String
The ID of the Edge Config that the schema should be for.
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