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

vercel.FirewallBypass

Explore with Pulumi AI

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

    Provides a Firewall Bypass Rule

    Firewall Bypass Rules configure sets of domains and ip address to prevent bypass Vercel’s system mitigations for. The hosts used in a bypass rule must be a production domain assigned to the associated project. Requests that bypass system mitigations will incur usage.

    Example Usage

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

const example = new vercel.Project("example", {name: "firewall-bypass-example"});
const bypassTargeted = new vercel.FirewallBypass("bypass_targeted", {
    projectId: example.id,
    sourceIp: "5.6.7.8",
    domain: "my-production-domain.com",
});
const bypassCidr = new vercel.FirewallBypass("bypass_cidr", {
    projectId: example.id,
    sourceIp: "52.33.44.0/24",
    domain: "my-production-domain.com",
});
const bypassAll = new vercel.FirewallBypass("bypass_all", {
    projectId: example.id,
    sourceIp: "52.33.44.0/24",
    domain: "*",
});

    import pulumi
import pulumiverse_vercel as vercel

example = vercel.Project("example", name="firewall-bypass-example")
bypass_targeted = vercel.FirewallBypass("bypass_targeted",
    project_id=example.id,
    source_ip="5.6.7.8",
    domain="my-production-domain.com")
bypass_cidr = vercel.FirewallBypass("bypass_cidr",
    project_id=example.id,
    source_ip="52.33.44.0/24",
    domain="my-production-domain.com")
bypass_all = vercel.FirewallBypass("bypass_all",
    project_id=example.id,
    source_ip="52.33.44.0/24",
    domain="*")

    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.NewProject(ctx, "example", &vercel.ProjectArgs{
			Name: pulumi.String("firewall-bypass-example"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewFirewallBypass(ctx, "bypass_targeted", &vercel.FirewallBypassArgs{
			ProjectId: example.ID(),
			SourceIp:  pulumi.String("5.6.7.8"),
			Domain:    pulumi.String("my-production-domain.com"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewFirewallBypass(ctx, "bypass_cidr", &vercel.FirewallBypassArgs{
			ProjectId: example.ID(),
			SourceIp:  pulumi.String("52.33.44.0/24"),
			Domain:    pulumi.String("my-production-domain.com"),
		})
		if err != nil {
			return err
		}
		_, err = vercel.NewFirewallBypass(ctx, "bypass_all", &vercel.FirewallBypassArgs{
			ProjectId: example.ID(),
			SourceIp:  pulumi.String("52.33.44.0/24"),
			Domain:    pulumi.String("*"),
		})
		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.Project("example", new()
    {
        Name = "firewall-bypass-example",
    });

    var bypassTargeted = new Vercel.FirewallBypass("bypass_targeted", new()
    {
        ProjectId = example.Id,
        SourceIp = "5.6.7.8",
        Domain = "my-production-domain.com",
    });

    var bypassCidr = new Vercel.FirewallBypass("bypass_cidr", new()
    {
        ProjectId = example.Id,
        SourceIp = "52.33.44.0/24",
        Domain = "my-production-domain.com",
    });

    var bypassAll = new Vercel.FirewallBypass("bypass_all", new()
    {
        ProjectId = example.Id,
        SourceIp = "52.33.44.0/24",
        Domain = "*",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.Project;
import com.pulumi.vercel.ProjectArgs;
import com.pulumi.vercel.FirewallBypass;
import com.pulumi.vercel.FirewallBypassArgs;
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 Project("example", ProjectArgs.builder()
            .name("firewall-bypass-example")
            .build());

        var bypassTargeted = new FirewallBypass("bypassTargeted", FirewallBypassArgs.builder()
            .projectId(example.id())
            .sourceIp("5.6.7.8")
            .domain("my-production-domain.com")
            .build());

        var bypassCidr = new FirewallBypass("bypassCidr", FirewallBypassArgs.builder()
            .projectId(example.id())
            .sourceIp("52.33.44.0/24")
            .domain("my-production-domain.com")
            .build());

        var bypassAll = new FirewallBypass("bypassAll", FirewallBypassArgs.builder()
            .projectId(example.id())
            .sourceIp("52.33.44.0/24")
            .domain("*")
            .build());

    }
}

    resources:
  example:
    type: vercel:Project
    properties:
      name: firewall-bypass-example
  bypassTargeted:
    type: vercel:FirewallBypass
    name: bypass_targeted
    properties:
      projectId: ${example.id}
      sourceIp: 5.6.7.8
      domain: my-production-domain.com
  bypassCidr:
    type: vercel:FirewallBypass
    name: bypass_cidr
    properties:
      projectId: ${example.id}
      sourceIp: 52.33.44.0/24
      domain: my-production-domain.com
  bypassAll:
    type: vercel:FirewallBypass
    name: bypass_all
    properties:
      projectId: ${example.id}
      sourceIp: 52.33.44.0/24
      domain: '*'

    Create FirewallBypass Resource

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

    Constructor syntax

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

@overload
def FirewallBypass(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   domain: Optional[str] = None,
                   project_id: Optional[str] = None,
                   source_ip: Optional[str] = None,
                   team_id: Optional[str] = None)
    func NewFirewallBypass(ctx *Context, name string, args FirewallBypassArgs, opts ...ResourceOption) (*FirewallBypass, error)
    public FirewallBypass(string name, FirewallBypassArgs args, CustomResourceOptions? opts = null)
    public FirewallBypass(String name, FirewallBypassArgs args)
public FirewallBypass(String name, FirewallBypassArgs args, CustomResourceOptions options)

    type: vercel:FirewallBypass
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 FirewallBypassArgs
    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 FirewallBypassArgs
    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 FirewallBypassArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FirewallBypassArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FirewallBypassArgs
    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 firewallBypassResource = new Vercel.FirewallBypass("firewallBypassResource", new()
{
    Domain = "string",
    ProjectId = "string",
    SourceIp = "string",
    TeamId = "string",
});

    example, err := vercel.NewFirewallBypass(ctx, "firewallBypassResource", &vercel.FirewallBypassArgs{
	Domain:    pulumi.String("string"),
	ProjectId: pulumi.String("string"),
	SourceIp:  pulumi.String("string"),
	TeamId:    pulumi.String("string"),
})

    var firewallBypassResource = new FirewallBypass("firewallBypassResource", FirewallBypassArgs.builder()
    .domain("string")
    .projectId("string")
    .sourceIp("string")
    .teamId("string")
    .build());

    firewall_bypass_resource = vercel.FirewallBypass("firewallBypassResource",
    domain="string",
    project_id="string",
    source_ip="string",
    team_id="string")

    const firewallBypassResource = new vercel.FirewallBypass("firewallBypassResource", {
    domain: "string",
    projectId: "string",
    sourceIp: "string",
    teamId: "string",
});

    type: vercel:FirewallBypass
properties:
    domain: string
    projectId: string
    sourceIp: string
    teamId: string

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

    Domain string
    The domain to configure the bypass rule for.
    ProjectId string
    The ID of the Project to assign the bypass rule to
    SourceIp string
    The source IP address to configure the bypass rule for.
    TeamId string
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    Domain string
    The domain to configure the bypass rule for.
    ProjectId string
    The ID of the Project to assign the bypass rule to
    SourceIp string
    The source IP address to configure the bypass rule for.
    TeamId string
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain String
    The domain to configure the bypass rule for.
    projectId String
    The ID of the Project to assign the bypass rule to
    sourceIp String
    The source IP address to configure the bypass rule for.
    teamId String
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain string
    The domain to configure the bypass rule for.
    projectId string
    The ID of the Project to assign the bypass rule to
    sourceIp string
    The source IP address to configure the bypass rule for.
    teamId string
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain str
    The domain to configure the bypass rule for.
    project_id str
    The ID of the Project to assign the bypass rule to
    source_ip str
    The source IP address to configure the bypass rule for.
    team_id str
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain String
    The domain to configure the bypass rule for.
    projectId String
    The ID of the Project to assign the bypass rule to
    sourceIp String
    The source IP address to configure the bypass rule for.
    teamId String
    The ID of the team the Project exists 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 FirewallBypass 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 FirewallBypass Resource

    Get an existing FirewallBypass 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?: FirewallBypassState, opts?: CustomResourceOptions): FirewallBypass
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        domain: Optional[str] = None,
        project_id: Optional[str] = None,
        source_ip: Optional[str] = None,
        team_id: Optional[str] = None) -> FirewallBypass
    func GetFirewallBypass(ctx *Context, name string, id IDInput, state *FirewallBypassState, opts ...ResourceOption) (*FirewallBypass, error)
    public static FirewallBypass Get(string name, Input<string> id, FirewallBypassState? state, CustomResourceOptions? opts = null)
    public static FirewallBypass get(String name, Output<String> id, FirewallBypassState state, CustomResourceOptions options)
    resources:  _:    type: vercel:FirewallBypass    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:
    Domain string
    The domain to configure the bypass rule for.
    ProjectId string
    The ID of the Project to assign the bypass rule to
    SourceIp string
    The source IP address to configure the bypass rule for.
    TeamId string
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    Domain string
    The domain to configure the bypass rule for.
    ProjectId string
    The ID of the Project to assign the bypass rule to
    SourceIp string
    The source IP address to configure the bypass rule for.
    TeamId string
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain String
    The domain to configure the bypass rule for.
    projectId String
    The ID of the Project to assign the bypass rule to
    sourceIp String
    The source IP address to configure the bypass rule for.
    teamId String
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain string
    The domain to configure the bypass rule for.
    projectId string
    The ID of the Project to assign the bypass rule to
    sourceIp string
    The source IP address to configure the bypass rule for.
    teamId string
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain str
    The domain to configure the bypass rule for.
    project_id str
    The ID of the Project to assign the bypass rule to
    source_ip str
    The source IP address to configure the bypass rule for.
    team_id str
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    domain String
    The domain to configure the bypass rule for.
    projectId String
    The ID of the Project to assign the bypass rule to
    sourceIp String
    The source IP address to configure the bypass rule for.
    teamId String
    The ID of the team the Project exists under. Required when configuring a team resource if a default team has not been set in the provider.

    Import

    $ pulumi import vercel:index/firewallBypass:FirewallBypass example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx#mybypasshost.com#3.4.5.0/24

    $ pulumi import vercel:index/firewallBypass:FirewallBypass example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx#3.4.5.0/24

    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