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

vercel.Project

Explore with Pulumi AI

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

    Example Usage

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

// A project that is connected to a git repository.
// Deployments will be created automatically
// on every branch push and merges onto the Production Branch.
const withGit = new vercel.Project("withGit", {
    framework: "nextjs",
    gitRepository: {
        repo: "vercel/some-repo",
        type: "github",
    },
});
// A project that is not connected to a git repository.
// Deployments will need to be created manually through
// terraform, or via the vercel CLI.
const example = new vercel.Project("example", {framework: "nextjs"});

    import pulumi
import pulumiverse_vercel as vercel

# A project that is connected to a git repository.
# Deployments will be created automatically
# on every branch push and merges onto the Production Branch.
with_git = vercel.Project("withGit",
    framework="nextjs",
    git_repository={
        "repo": "vercel/some-repo",
        "type": "github",
    })
# A project that is not connected to a git repository.
# Deployments will need to be created manually through
# terraform, or via the vercel CLI.
example = vercel.Project("example", framework="nextjs")

    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 {
		// A project that is connected to a git repository.
		// Deployments will be created automatically
		// on every branch push and merges onto the Production Branch.
		_, err := vercel.NewProject(ctx, "withGit", &vercel.ProjectArgs{
			Framework: pulumi.String("nextjs"),
			GitRepository: &vercel.ProjectGitRepositoryArgs{
				Repo: pulumi.String("vercel/some-repo"),
				Type: pulumi.String("github"),
			},
		})
		if err != nil {
			return err
		}
		// A project that is not connected to a git repository.
		// Deployments will need to be created manually through
		// terraform, or via the vercel CLI.
		_, err = vercel.NewProject(ctx, "example", &vercel.ProjectArgs{
			Framework: pulumi.String("nextjs"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vercel = Pulumiverse.Vercel;

return await Deployment.RunAsync(() => 
{
    // A project that is connected to a git repository.
    // Deployments will be created automatically
    // on every branch push and merges onto the Production Branch.
    var withGit = new Vercel.Project("withGit", new()
    {
        Framework = "nextjs",
        GitRepository = new Vercel.Inputs.ProjectGitRepositoryArgs
        {
            Repo = "vercel/some-repo",
            Type = "github",
        },
    });

    // A project that is not connected to a git repository.
    // Deployments will need to be created manually through
    // terraform, or via the vercel CLI.
    var example = new Vercel.Project("example", new()
    {
        Framework = "nextjs",
    });

});

    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.inputs.ProjectGitRepositoryArgs;
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) {
        // A project that is connected to a git repository.
        // Deployments will be created automatically
        // on every branch push and merges onto the Production Branch.
        var withGit = new Project("withGit", ProjectArgs.builder()
            .framework("nextjs")
            .gitRepository(ProjectGitRepositoryArgs.builder()
                .repo("vercel/some-repo")
                .type("github")
                .build())
            .build());

        // A project that is not connected to a git repository.
        // Deployments will need to be created manually through
        // terraform, or via the vercel CLI.
        var example = new Project("example", ProjectArgs.builder()
            .framework("nextjs")
            .build());

    }
}

    resources:
  # A project that is connected to a git repository.
  # // Deployments will be created automatically
  # // on every branch push and merges onto the Production Branch.
  withGit:
    type: vercel:Project
    properties:
      framework: nextjs
      gitRepository:
        repo: vercel/some-repo
        type: github
  # A project that is not connected to a git repository.
  # // Deployments will need to be created manually through
  # // terraform, or via the vercel CLI.
  example:
    type: vercel:Project
    properties:
      framework: nextjs

    Create Project Resource

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

    Constructor syntax

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

@overload
def Project(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            auto_assign_custom_domains: Optional[bool] = None,
            automatically_expose_system_environment_variables: Optional[bool] = None,
            build_command: Optional[str] = None,
            customer_success_code_visibility: Optional[bool] = None,
            dev_command: Optional[str] = None,
            directory_listing: Optional[bool] = None,
            environments: Optional[Sequence[ProjectEnvironmentArgs]] = None,
            framework: Optional[str] = None,
            function_failover: Optional[bool] = None,
            git_comments: Optional[ProjectGitCommentsArgs] = None,
            git_fork_protection: Optional[bool] = None,
            git_lfs: Optional[bool] = None,
            git_repository: Optional[ProjectGitRepositoryArgs] = None,
            ignore_command: Optional[str] = None,
            install_command: Optional[str] = None,
            name: Optional[str] = None,
            oidc_token_config: Optional[ProjectOidcTokenConfigArgs] = None,
            options_allowlist: Optional[ProjectOptionsAllowlistArgs] = None,
            output_directory: Optional[str] = None,
            password_protection: Optional[ProjectPasswordProtectionArgs] = None,
            preview_comments: Optional[bool] = None,
            prioritise_production_builds: Optional[bool] = None,
            protection_bypass_for_automation: Optional[bool] = None,
            public_source: Optional[bool] = None,
            resource_config: Optional[ProjectResourceConfigArgs] = None,
            root_directory: Optional[str] = None,
            serverless_function_region: Optional[str] = None,
            skew_protection: Optional[str] = None,
            team_id: Optional[str] = None,
            trusted_ips: Optional[ProjectTrustedIpsArgs] = None,
            vercel_authentication: Optional[ProjectVercelAuthenticationArgs] = None)
    func NewProject(ctx *Context, name string, args *ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs? args = null, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
public Project(String name, ProjectArgs args, CustomResourceOptions options)

    type: vercel:Project
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 ProjectArgs
    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 ProjectArgs
    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 ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    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 projectResource = new Vercel.Project("projectResource", new()
{
    AutoAssignCustomDomains = false,
    AutomaticallyExposeSystemEnvironmentVariables = false,
    BuildCommand = "string",
    CustomerSuccessCodeVisibility = false,
    DevCommand = "string",
    DirectoryListing = false,
    Environments = new[]
    {
        new Vercel.Inputs.ProjectEnvironmentArgs
        {
            Key = "string",
            Targets = new[]
            {
                "string",
            },
            Value = "string",
            GitBranch = "string",
            Id = "string",
            Sensitive = false,
        },
    },
    Framework = "string",
    FunctionFailover = false,
    GitComments = new Vercel.Inputs.ProjectGitCommentsArgs
    {
        OnCommit = false,
        OnPullRequest = false,
    },
    GitForkProtection = false,
    GitLfs = false,
    GitRepository = new Vercel.Inputs.ProjectGitRepositoryArgs
    {
        Repo = "string",
        Type = "string",
        DeployHooks = new[]
        {
            new Vercel.Inputs.ProjectGitRepositoryDeployHookArgs
            {
                Name = "string",
                Ref = "string",
                Id = "string",
                Url = "string",
            },
        },
        ProductionBranch = "string",
    },
    IgnoreCommand = "string",
    InstallCommand = "string",
    Name = "string",
    OidcTokenConfig = new Vercel.Inputs.ProjectOidcTokenConfigArgs
    {
        Enabled = false,
    },
    OptionsAllowlist = new Vercel.Inputs.ProjectOptionsAllowlistArgs
    {
        Paths = new[]
        {
            new Vercel.Inputs.ProjectOptionsAllowlistPathArgs
            {
                Value = "string",
            },
        },
    },
    OutputDirectory = "string",
    PasswordProtection = new Vercel.Inputs.ProjectPasswordProtectionArgs
    {
        DeploymentType = "string",
        Password = "string",
    },
    PreviewComments = false,
    PrioritiseProductionBuilds = false,
    ProtectionBypassForAutomation = false,
    PublicSource = false,
    ResourceConfig = new Vercel.Inputs.ProjectResourceConfigArgs
    {
        FunctionDefaultCpuType = "string",
        FunctionDefaultTimeout = 0,
    },
    RootDirectory = "string",
    ServerlessFunctionRegion = "string",
    SkewProtection = "string",
    TeamId = "string",
    TrustedIps = new Vercel.Inputs.ProjectTrustedIpsArgs
    {
        Addresses = new[]
        {
            new Vercel.Inputs.ProjectTrustedIpsAddressArgs
            {
                Value = "string",
                Note = "string",
            },
        },
        DeploymentType = "string",
        ProtectionMode = "string",
    },
    VercelAuthentication = new Vercel.Inputs.ProjectVercelAuthenticationArgs
    {
        DeploymentType = "string",
    },
});

    example, err := vercel.NewProject(ctx, "projectResource", &vercel.ProjectArgs{
	AutoAssignCustomDomains:                       pulumi.Bool(false),
	AutomaticallyExposeSystemEnvironmentVariables: pulumi.Bool(false),
	BuildCommand:                  pulumi.String("string"),
	CustomerSuccessCodeVisibility: pulumi.Bool(false),
	DevCommand:                    pulumi.String("string"),
	DirectoryListing:              pulumi.Bool(false),
	Environments: vercel.ProjectEnvironmentArray{
		&vercel.ProjectEnvironmentArgs{
			Key: pulumi.String("string"),
			Targets: pulumi.StringArray{
				pulumi.String("string"),
			},
			Value:     pulumi.String("string"),
			GitBranch: pulumi.String("string"),
			Id:        pulumi.String("string"),
			Sensitive: pulumi.Bool(false),
		},
	},
	Framework:        pulumi.String("string"),
	FunctionFailover: pulumi.Bool(false),
	GitComments: &vercel.ProjectGitCommentsArgs{
		OnCommit:      pulumi.Bool(false),
		OnPullRequest: pulumi.Bool(false),
	},
	GitForkProtection: pulumi.Bool(false),
	GitLfs:            pulumi.Bool(false),
	GitRepository: &vercel.ProjectGitRepositoryArgs{
		Repo: pulumi.String("string"),
		Type: pulumi.String("string"),
		DeployHooks: vercel.ProjectGitRepositoryDeployHookArray{
			&vercel.ProjectGitRepositoryDeployHookArgs{
				Name: pulumi.String("string"),
				Ref:  pulumi.String("string"),
				Id:   pulumi.String("string"),
				Url:  pulumi.String("string"),
			},
		},
		ProductionBranch: pulumi.String("string"),
	},
	IgnoreCommand:  pulumi.String("string"),
	InstallCommand: pulumi.String("string"),
	Name:           pulumi.String("string"),
	OidcTokenConfig: &vercel.ProjectOidcTokenConfigArgs{
		Enabled: pulumi.Bool(false),
	},
	OptionsAllowlist: &vercel.ProjectOptionsAllowlistArgs{
		Paths: vercel.ProjectOptionsAllowlistPathArray{
			&vercel.ProjectOptionsAllowlistPathArgs{
				Value: pulumi.String("string"),
			},
		},
	},
	OutputDirectory: pulumi.String("string"),
	PasswordProtection: &vercel.ProjectPasswordProtectionArgs{
		DeploymentType: pulumi.String("string"),
		Password:       pulumi.String("string"),
	},
	PreviewComments:               pulumi.Bool(false),
	PrioritiseProductionBuilds:    pulumi.Bool(false),
	ProtectionBypassForAutomation: pulumi.Bool(false),
	PublicSource:                  pulumi.Bool(false),
	ResourceConfig: &vercel.ProjectResourceConfigArgs{
		FunctionDefaultCpuType: pulumi.String("string"),
		FunctionDefaultTimeout: pulumi.Int(0),
	},
	RootDirectory:            pulumi.String("string"),
	ServerlessFunctionRegion: pulumi.String("string"),
	SkewProtection:           pulumi.String("string"),
	TeamId:                   pulumi.String("string"),
	TrustedIps: &vercel.ProjectTrustedIpsArgs{
		Addresses: vercel.ProjectTrustedIpsAddressArray{
			&vercel.ProjectTrustedIpsAddressArgs{
				Value: pulumi.String("string"),
				Note:  pulumi.String("string"),
			},
		},
		DeploymentType: pulumi.String("string"),
		ProtectionMode: pulumi.String("string"),
	},
	VercelAuthentication: &vercel.ProjectVercelAuthenticationArgs{
		DeploymentType: pulumi.String("string"),
	},
})

    var projectResource = new Project("projectResource", ProjectArgs.builder()
    .autoAssignCustomDomains(false)
    .automaticallyExposeSystemEnvironmentVariables(false)
    .buildCommand("string")
    .customerSuccessCodeVisibility(false)
    .devCommand("string")
    .directoryListing(false)
    .environments(ProjectEnvironmentArgs.builder()
        .key("string")
        .targets("string")
        .value("string")
        .gitBranch("string")
        .id("string")
        .sensitive(false)
        .build())
    .framework("string")
    .functionFailover(false)
    .gitComments(ProjectGitCommentsArgs.builder()
        .onCommit(false)
        .onPullRequest(false)
        .build())
    .gitForkProtection(false)
    .gitLfs(false)
    .gitRepository(ProjectGitRepositoryArgs.builder()
        .repo("string")
        .type("string")
        .deployHooks(ProjectGitRepositoryDeployHookArgs.builder()
            .name("string")
            .ref("string")
            .id("string")
            .url("string")
            .build())
        .productionBranch("string")
        .build())
    .ignoreCommand("string")
    .installCommand("string")
    .name("string")
    .oidcTokenConfig(ProjectOidcTokenConfigArgs.builder()
        .enabled(false)
        .build())
    .optionsAllowlist(ProjectOptionsAllowlistArgs.builder()
        .paths(ProjectOptionsAllowlistPathArgs.builder()
            .value("string")
            .build())
        .build())
    .outputDirectory("string")
    .passwordProtection(ProjectPasswordProtectionArgs.builder()
        .deploymentType("string")
        .password("string")
        .build())
    .previewComments(false)
    .prioritiseProductionBuilds(false)
    .protectionBypassForAutomation(false)
    .publicSource(false)
    .resourceConfig(ProjectResourceConfigArgs.builder()
        .functionDefaultCpuType("string")
        .functionDefaultTimeout(0)
        .build())
    .rootDirectory("string")
    .serverlessFunctionRegion("string")
    .skewProtection("string")
    .teamId("string")
    .trustedIps(ProjectTrustedIpsArgs.builder()
        .addresses(ProjectTrustedIpsAddressArgs.builder()
            .value("string")
            .note("string")
            .build())
        .deploymentType("string")
        .protectionMode("string")
        .build())
    .vercelAuthentication(ProjectVercelAuthenticationArgs.builder()
        .deploymentType("string")
        .build())
    .build());

    project_resource = vercel.Project("projectResource",
    auto_assign_custom_domains=False,
    automatically_expose_system_environment_variables=False,
    build_command="string",
    customer_success_code_visibility=False,
    dev_command="string",
    directory_listing=False,
    environments=[{
        "key": "string",
        "targets": ["string"],
        "value": "string",
        "git_branch": "string",
        "id": "string",
        "sensitive": False,
    }],
    framework="string",
    function_failover=False,
    git_comments={
        "on_commit": False,
        "on_pull_request": False,
    },
    git_fork_protection=False,
    git_lfs=False,
    git_repository={
        "repo": "string",
        "type": "string",
        "deploy_hooks": [{
            "name": "string",
            "ref": "string",
            "id": "string",
            "url": "string",
        }],
        "production_branch": "string",
    },
    ignore_command="string",
    install_command="string",
    name="string",
    oidc_token_config={
        "enabled": False,
    },
    options_allowlist={
        "paths": [{
            "value": "string",
        }],
    },
    output_directory="string",
    password_protection={
        "deployment_type": "string",
        "password": "string",
    },
    preview_comments=False,
    prioritise_production_builds=False,
    protection_bypass_for_automation=False,
    public_source=False,
    resource_config={
        "function_default_cpu_type": "string",
        "function_default_timeout": 0,
    },
    root_directory="string",
    serverless_function_region="string",
    skew_protection="string",
    team_id="string",
    trusted_ips={
        "addresses": [{
            "value": "string",
            "note": "string",
        }],
        "deployment_type": "string",
        "protection_mode": "string",
    },
    vercel_authentication={
        "deployment_type": "string",
    })

    const projectResource = new vercel.Project("projectResource", {
    autoAssignCustomDomains: false,
    automaticallyExposeSystemEnvironmentVariables: false,
    buildCommand: "string",
    customerSuccessCodeVisibility: false,
    devCommand: "string",
    directoryListing: false,
    environments: [{
        key: "string",
        targets: ["string"],
        value: "string",
        gitBranch: "string",
        id: "string",
        sensitive: false,
    }],
    framework: "string",
    functionFailover: false,
    gitComments: {
        onCommit: false,
        onPullRequest: false,
    },
    gitForkProtection: false,
    gitLfs: false,
    gitRepository: {
        repo: "string",
        type: "string",
        deployHooks: [{
            name: "string",
            ref: "string",
            id: "string",
            url: "string",
        }],
        productionBranch: "string",
    },
    ignoreCommand: "string",
    installCommand: "string",
    name: "string",
    oidcTokenConfig: {
        enabled: false,
    },
    optionsAllowlist: {
        paths: [{
            value: "string",
        }],
    },
    outputDirectory: "string",
    passwordProtection: {
        deploymentType: "string",
        password: "string",
    },
    previewComments: false,
    prioritiseProductionBuilds: false,
    protectionBypassForAutomation: false,
    publicSource: false,
    resourceConfig: {
        functionDefaultCpuType: "string",
        functionDefaultTimeout: 0,
    },
    rootDirectory: "string",
    serverlessFunctionRegion: "string",
    skewProtection: "string",
    teamId: "string",
    trustedIps: {
        addresses: [{
            value: "string",
            note: "string",
        }],
        deploymentType: "string",
        protectionMode: "string",
    },
    vercelAuthentication: {
        deploymentType: "string",
    },
});

    type: vercel:Project
properties:
    autoAssignCustomDomains: false
    automaticallyExposeSystemEnvironmentVariables: false
    buildCommand: string
    customerSuccessCodeVisibility: false
    devCommand: string
    directoryListing: false
    environments:
        - gitBranch: string
          id: string
          key: string
          sensitive: false
          targets:
            - string
          value: string
    framework: string
    functionFailover: false
    gitComments:
        onCommit: false
        onPullRequest: false
    gitForkProtection: false
    gitLfs: false
    gitRepository:
        deployHooks:
            - id: string
              name: string
              ref: string
              url: string
        productionBranch: string
        repo: string
        type: string
    ignoreCommand: string
    installCommand: string
    name: string
    oidcTokenConfig:
        enabled: false
    optionsAllowlist:
        paths:
            - value: string
    outputDirectory: string
    passwordProtection:
        deploymentType: string
        password: string
    previewComments: false
    prioritiseProductionBuilds: false
    protectionBypassForAutomation: false
    publicSource: false
    resourceConfig:
        functionDefaultCpuType: string
        functionDefaultTimeout: 0
    rootDirectory: string
    serverlessFunctionRegion: string
    skewProtection: string
    teamId: string
    trustedIps:
        addresses:
            - note: string
              value: string
        deploymentType: string
        protectionMode: string
    vercelAuthentication:
        deploymentType: string

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

    AutoAssignCustomDomains bool
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    AutomaticallyExposeSystemEnvironmentVariables bool
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    BuildCommand string
    The build command for this project. If omitted, this value will be automatically detected.
    CustomerSuccessCodeVisibility bool
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    DevCommand string
    The dev command for this project. If omitted, this value will be automatically detected.
    DirectoryListing bool
    If no index file is present within a directory, the directory contents will be displayed.
    Environments List<Pulumiverse.Vercel.Inputs.ProjectEnvironment>
    A set of Environment Variables that should be configured for the project.
    Framework string
    The framework that is being used for this project. If omitted, no framework is selected.
    FunctionFailover bool
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    GitComments Pulumiverse.Vercel.Inputs.ProjectGitComments
    Configuration for Git Comments.
    GitForkProtection bool
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    GitLfs bool
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    GitRepository Pulumiverse.Vercel.Inputs.ProjectGitRepository
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    IgnoreCommand string
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    InstallCommand string
    The install command for this project. If omitted, this value will be automatically detected.
    Name string
    The desired name for the project.
    OidcTokenConfig Pulumiverse.Vercel.Inputs.ProjectOidcTokenConfig
    Configuration for OpenID Connect (OIDC) tokens.
    OptionsAllowlist Pulumiverse.Vercel.Inputs.ProjectOptionsAllowlist
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    OutputDirectory string
    The output directory of the project. If omitted, this value will be automatically detected.
    PasswordProtection Pulumiverse.Vercel.Inputs.ProjectPasswordProtection
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    PreviewComments bool
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    PrioritiseProductionBuilds bool
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    ProtectionBypassForAutomation bool
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    PublicSource bool
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    ResourceConfig Pulumiverse.Vercel.Inputs.ProjectResourceConfig
    Resource Configuration for the project.
    RootDirectory string
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    ServerlessFunctionRegion string
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    SkewProtection string
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    TeamId string
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    TrustedIps Pulumiverse.Vercel.Inputs.ProjectTrustedIps
    Ensures only visitors from an allowed IP address can access your deployment.
    VercelAuthentication Pulumiverse.Vercel.Inputs.ProjectVercelAuthentication
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    AutoAssignCustomDomains bool
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    AutomaticallyExposeSystemEnvironmentVariables bool
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    BuildCommand string
    The build command for this project. If omitted, this value will be automatically detected.
    CustomerSuccessCodeVisibility bool
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    DevCommand string
    The dev command for this project. If omitted, this value will be automatically detected.
    DirectoryListing bool
    If no index file is present within a directory, the directory contents will be displayed.
    Environments []ProjectEnvironmentArgs
    A set of Environment Variables that should be configured for the project.
    Framework string
    The framework that is being used for this project. If omitted, no framework is selected.
    FunctionFailover bool
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    GitComments ProjectGitCommentsArgs
    Configuration for Git Comments.
    GitForkProtection bool
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    GitLfs bool
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    GitRepository ProjectGitRepositoryArgs
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    IgnoreCommand string
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    InstallCommand string
    The install command for this project. If omitted, this value will be automatically detected.
    Name string
    The desired name for the project.
    OidcTokenConfig ProjectOidcTokenConfigArgs
    Configuration for OpenID Connect (OIDC) tokens.
    OptionsAllowlist ProjectOptionsAllowlistArgs
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    OutputDirectory string
    The output directory of the project. If omitted, this value will be automatically detected.
    PasswordProtection ProjectPasswordProtectionArgs
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    PreviewComments bool
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    PrioritiseProductionBuilds bool
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    ProtectionBypassForAutomation bool
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    PublicSource bool
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    ResourceConfig ProjectResourceConfigArgs
    Resource Configuration for the project.
    RootDirectory string
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    ServerlessFunctionRegion string
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    SkewProtection string
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    TeamId string
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    TrustedIps ProjectTrustedIpsArgs
    Ensures only visitors from an allowed IP address can access your deployment.
    VercelAuthentication ProjectVercelAuthenticationArgs
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    autoAssignCustomDomains Boolean
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automaticallyExposeSystemEnvironmentVariables Boolean
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    buildCommand String
    The build command for this project. If omitted, this value will be automatically detected.
    customerSuccessCodeVisibility Boolean
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    devCommand String
    The dev command for this project. If omitted, this value will be automatically detected.
    directoryListing Boolean
    If no index file is present within a directory, the directory contents will be displayed.
    environments List<ProjectEnvironment>
    A set of Environment Variables that should be configured for the project.
    framework String
    The framework that is being used for this project. If omitted, no framework is selected.
    functionFailover Boolean
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    gitComments ProjectGitComments
    Configuration for Git Comments.
    gitForkProtection Boolean
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    gitLfs Boolean
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    gitRepository ProjectGitRepository
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignoreCommand String
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    installCommand String
    The install command for this project. If omitted, this value will be automatically detected.
    name String
    The desired name for the project.
    oidcTokenConfig ProjectOidcTokenConfig
    Configuration for OpenID Connect (OIDC) tokens.
    optionsAllowlist ProjectOptionsAllowlist
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    outputDirectory String
    The output directory of the project. If omitted, this value will be automatically detected.
    passwordProtection ProjectPasswordProtection
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    previewComments Boolean
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritiseProductionBuilds Boolean
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protectionBypassForAutomation Boolean
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    publicSource Boolean
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resourceConfig ProjectResourceConfig
    Resource Configuration for the project.
    rootDirectory String
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverlessFunctionRegion String
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skewProtection String
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    teamId String
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trustedIps ProjectTrustedIps
    Ensures only visitors from an allowed IP address can access your deployment.
    vercelAuthentication ProjectVercelAuthentication
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    autoAssignCustomDomains boolean
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automaticallyExposeSystemEnvironmentVariables boolean
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    buildCommand string
    The build command for this project. If omitted, this value will be automatically detected.
    customerSuccessCodeVisibility boolean
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    devCommand string
    The dev command for this project. If omitted, this value will be automatically detected.
    directoryListing boolean
    If no index file is present within a directory, the directory contents will be displayed.
    environments ProjectEnvironment[]
    A set of Environment Variables that should be configured for the project.
    framework string
    The framework that is being used for this project. If omitted, no framework is selected.
    functionFailover boolean
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    gitComments ProjectGitComments
    Configuration for Git Comments.
    gitForkProtection boolean
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    gitLfs boolean
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    gitRepository ProjectGitRepository
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignoreCommand string
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    installCommand string
    The install command for this project. If omitted, this value will be automatically detected.
    name string
    The desired name for the project.
    oidcTokenConfig ProjectOidcTokenConfig
    Configuration for OpenID Connect (OIDC) tokens.
    optionsAllowlist ProjectOptionsAllowlist
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    outputDirectory string
    The output directory of the project. If omitted, this value will be automatically detected.
    passwordProtection ProjectPasswordProtection
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    previewComments boolean
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritiseProductionBuilds boolean
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protectionBypassForAutomation boolean
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    publicSource boolean
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resourceConfig ProjectResourceConfig
    Resource Configuration for the project.
    rootDirectory string
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverlessFunctionRegion string
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skewProtection string
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    teamId string
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trustedIps ProjectTrustedIps
    Ensures only visitors from an allowed IP address can access your deployment.
    vercelAuthentication ProjectVercelAuthentication
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    auto_assign_custom_domains bool
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automatically_expose_system_environment_variables bool
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    build_command str
    The build command for this project. If omitted, this value will be automatically detected.
    customer_success_code_visibility bool
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    dev_command str
    The dev command for this project. If omitted, this value will be automatically detected.
    directory_listing bool
    If no index file is present within a directory, the directory contents will be displayed.
    environments Sequence[ProjectEnvironmentArgs]
    A set of Environment Variables that should be configured for the project.
    framework str
    The framework that is being used for this project. If omitted, no framework is selected.
    function_failover bool
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    git_comments ProjectGitCommentsArgs
    Configuration for Git Comments.
    git_fork_protection bool
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    git_lfs bool
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    git_repository ProjectGitRepositoryArgs
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignore_command str
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    install_command str
    The install command for this project. If omitted, this value will be automatically detected.
    name str
    The desired name for the project.
    oidc_token_config ProjectOidcTokenConfigArgs
    Configuration for OpenID Connect (OIDC) tokens.
    options_allowlist ProjectOptionsAllowlistArgs
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    output_directory str
    The output directory of the project. If omitted, this value will be automatically detected.
    password_protection ProjectPasswordProtectionArgs
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    preview_comments bool
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritise_production_builds bool
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protection_bypass_for_automation bool
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    public_source bool
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resource_config ProjectResourceConfigArgs
    Resource Configuration for the project.
    root_directory str
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverless_function_region str
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skew_protection str
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    team_id str
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trusted_ips ProjectTrustedIpsArgs
    Ensures only visitors from an allowed IP address can access your deployment.
    vercel_authentication ProjectVercelAuthenticationArgs
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    autoAssignCustomDomains Boolean
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automaticallyExposeSystemEnvironmentVariables Boolean
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    buildCommand String
    The build command for this project. If omitted, this value will be automatically detected.
    customerSuccessCodeVisibility Boolean
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    devCommand String
    The dev command for this project. If omitted, this value will be automatically detected.
    directoryListing Boolean
    If no index file is present within a directory, the directory contents will be displayed.
    environments List<Property Map>
    A set of Environment Variables that should be configured for the project.
    framework String
    The framework that is being used for this project. If omitted, no framework is selected.
    functionFailover Boolean
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    gitComments Property Map
    Configuration for Git Comments.
    gitForkProtection Boolean
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    gitLfs Boolean
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    gitRepository Property Map
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignoreCommand String
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    installCommand String
    The install command for this project. If omitted, this value will be automatically detected.
    name String
    The desired name for the project.
    oidcTokenConfig Property Map
    Configuration for OpenID Connect (OIDC) tokens.
    optionsAllowlist Property Map
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    outputDirectory String
    The output directory of the project. If omitted, this value will be automatically detected.
    passwordProtection Property Map
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    previewComments Boolean
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritiseProductionBuilds Boolean
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protectionBypassForAutomation Boolean
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    publicSource Boolean
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resourceConfig Property Map
    Resource Configuration for the project.
    rootDirectory String
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverlessFunctionRegion String
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skewProtection String
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    teamId String
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trustedIps Property Map
    Ensures only visitors from an allowed IP address can access your deployment.
    vercelAuthentication Property Map
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ProtectionBypassForAutomationSecret string
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProtectionBypassForAutomationSecret string
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    id String
    The provider-assigned unique ID for this managed resource.
    protectionBypassForAutomationSecret String
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    id string
    The provider-assigned unique ID for this managed resource.
    protectionBypassForAutomationSecret string
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    id str
    The provider-assigned unique ID for this managed resource.
    protection_bypass_for_automation_secret str
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    id String
    The provider-assigned unique ID for this managed resource.
    protectionBypassForAutomationSecret String
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.

    Look up Existing Project Resource

    Get an existing Project 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?: ProjectState, opts?: CustomResourceOptions): Project
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_assign_custom_domains: Optional[bool] = None,
        automatically_expose_system_environment_variables: Optional[bool] = None,
        build_command: Optional[str] = None,
        customer_success_code_visibility: Optional[bool] = None,
        dev_command: Optional[str] = None,
        directory_listing: Optional[bool] = None,
        environments: Optional[Sequence[ProjectEnvironmentArgs]] = None,
        framework: Optional[str] = None,
        function_failover: Optional[bool] = None,
        git_comments: Optional[ProjectGitCommentsArgs] = None,
        git_fork_protection: Optional[bool] = None,
        git_lfs: Optional[bool] = None,
        git_repository: Optional[ProjectGitRepositoryArgs] = None,
        ignore_command: Optional[str] = None,
        install_command: Optional[str] = None,
        name: Optional[str] = None,
        oidc_token_config: Optional[ProjectOidcTokenConfigArgs] = None,
        options_allowlist: Optional[ProjectOptionsAllowlistArgs] = None,
        output_directory: Optional[str] = None,
        password_protection: Optional[ProjectPasswordProtectionArgs] = None,
        preview_comments: Optional[bool] = None,
        prioritise_production_builds: Optional[bool] = None,
        protection_bypass_for_automation: Optional[bool] = None,
        protection_bypass_for_automation_secret: Optional[str] = None,
        public_source: Optional[bool] = None,
        resource_config: Optional[ProjectResourceConfigArgs] = None,
        root_directory: Optional[str] = None,
        serverless_function_region: Optional[str] = None,
        skew_protection: Optional[str] = None,
        team_id: Optional[str] = None,
        trusted_ips: Optional[ProjectTrustedIpsArgs] = None,
        vercel_authentication: Optional[ProjectVercelAuthenticationArgs] = None) -> Project
    func GetProject(ctx *Context, name string, id IDInput, state *ProjectState, opts ...ResourceOption) (*Project, error)
    public static Project Get(string name, Input<string> id, ProjectState? state, CustomResourceOptions? opts = null)
    public static Project get(String name, Output<String> id, ProjectState 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:
    AutoAssignCustomDomains bool
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    AutomaticallyExposeSystemEnvironmentVariables bool
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    BuildCommand string
    The build command for this project. If omitted, this value will be automatically detected.
    CustomerSuccessCodeVisibility bool
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    DevCommand string
    The dev command for this project. If omitted, this value will be automatically detected.
    DirectoryListing bool
    If no index file is present within a directory, the directory contents will be displayed.
    Environments List<Pulumiverse.Vercel.Inputs.ProjectEnvironment>
    A set of Environment Variables that should be configured for the project.
    Framework string
    The framework that is being used for this project. If omitted, no framework is selected.
    FunctionFailover bool
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    GitComments Pulumiverse.Vercel.Inputs.ProjectGitComments
    Configuration for Git Comments.
    GitForkProtection bool
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    GitLfs bool
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    GitRepository Pulumiverse.Vercel.Inputs.ProjectGitRepository
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    IgnoreCommand string
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    InstallCommand string
    The install command for this project. If omitted, this value will be automatically detected.
    Name string
    The desired name for the project.
    OidcTokenConfig Pulumiverse.Vercel.Inputs.ProjectOidcTokenConfig
    Configuration for OpenID Connect (OIDC) tokens.
    OptionsAllowlist Pulumiverse.Vercel.Inputs.ProjectOptionsAllowlist
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    OutputDirectory string
    The output directory of the project. If omitted, this value will be automatically detected.
    PasswordProtection Pulumiverse.Vercel.Inputs.ProjectPasswordProtection
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    PreviewComments bool
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    PrioritiseProductionBuilds bool
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    ProtectionBypassForAutomation bool
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    ProtectionBypassForAutomationSecret string
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    PublicSource bool
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    ResourceConfig Pulumiverse.Vercel.Inputs.ProjectResourceConfig
    Resource Configuration for the project.
    RootDirectory string
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    ServerlessFunctionRegion string
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    SkewProtection string
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    TeamId string
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    TrustedIps Pulumiverse.Vercel.Inputs.ProjectTrustedIps
    Ensures only visitors from an allowed IP address can access your deployment.
    VercelAuthentication Pulumiverse.Vercel.Inputs.ProjectVercelAuthentication
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    AutoAssignCustomDomains bool
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    AutomaticallyExposeSystemEnvironmentVariables bool
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    BuildCommand string
    The build command for this project. If omitted, this value will be automatically detected.
    CustomerSuccessCodeVisibility bool
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    DevCommand string
    The dev command for this project. If omitted, this value will be automatically detected.
    DirectoryListing bool
    If no index file is present within a directory, the directory contents will be displayed.
    Environments []ProjectEnvironmentArgs
    A set of Environment Variables that should be configured for the project.
    Framework string
    The framework that is being used for this project. If omitted, no framework is selected.
    FunctionFailover bool
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    GitComments ProjectGitCommentsArgs
    Configuration for Git Comments.
    GitForkProtection bool
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    GitLfs bool
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    GitRepository ProjectGitRepositoryArgs
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    IgnoreCommand string
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    InstallCommand string
    The install command for this project. If omitted, this value will be automatically detected.
    Name string
    The desired name for the project.
    OidcTokenConfig ProjectOidcTokenConfigArgs
    Configuration for OpenID Connect (OIDC) tokens.
    OptionsAllowlist ProjectOptionsAllowlistArgs
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    OutputDirectory string
    The output directory of the project. If omitted, this value will be automatically detected.
    PasswordProtection ProjectPasswordProtectionArgs
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    PreviewComments bool
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    PrioritiseProductionBuilds bool
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    ProtectionBypassForAutomation bool
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    ProtectionBypassForAutomationSecret string
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    PublicSource bool
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    ResourceConfig ProjectResourceConfigArgs
    Resource Configuration for the project.
    RootDirectory string
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    ServerlessFunctionRegion string
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    SkewProtection string
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    TeamId string
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    TrustedIps ProjectTrustedIpsArgs
    Ensures only visitors from an allowed IP address can access your deployment.
    VercelAuthentication ProjectVercelAuthenticationArgs
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    autoAssignCustomDomains Boolean
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automaticallyExposeSystemEnvironmentVariables Boolean
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    buildCommand String
    The build command for this project. If omitted, this value will be automatically detected.
    customerSuccessCodeVisibility Boolean
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    devCommand String
    The dev command for this project. If omitted, this value will be automatically detected.
    directoryListing Boolean
    If no index file is present within a directory, the directory contents will be displayed.
    environments List<ProjectEnvironment>
    A set of Environment Variables that should be configured for the project.
    framework String
    The framework that is being used for this project. If omitted, no framework is selected.
    functionFailover Boolean
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    gitComments ProjectGitComments
    Configuration for Git Comments.
    gitForkProtection Boolean
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    gitLfs Boolean
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    gitRepository ProjectGitRepository
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignoreCommand String
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    installCommand String
    The install command for this project. If omitted, this value will be automatically detected.
    name String
    The desired name for the project.
    oidcTokenConfig ProjectOidcTokenConfig
    Configuration for OpenID Connect (OIDC) tokens.
    optionsAllowlist ProjectOptionsAllowlist
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    outputDirectory String
    The output directory of the project. If omitted, this value will be automatically detected.
    passwordProtection ProjectPasswordProtection
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    previewComments Boolean
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritiseProductionBuilds Boolean
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protectionBypassForAutomation Boolean
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    protectionBypassForAutomationSecret String
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    publicSource Boolean
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resourceConfig ProjectResourceConfig
    Resource Configuration for the project.
    rootDirectory String
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverlessFunctionRegion String
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skewProtection String
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    teamId String
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trustedIps ProjectTrustedIps
    Ensures only visitors from an allowed IP address can access your deployment.
    vercelAuthentication ProjectVercelAuthentication
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    autoAssignCustomDomains boolean
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automaticallyExposeSystemEnvironmentVariables boolean
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    buildCommand string
    The build command for this project. If omitted, this value will be automatically detected.
    customerSuccessCodeVisibility boolean
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    devCommand string
    The dev command for this project. If omitted, this value will be automatically detected.
    directoryListing boolean
    If no index file is present within a directory, the directory contents will be displayed.
    environments ProjectEnvironment[]
    A set of Environment Variables that should be configured for the project.
    framework string
    The framework that is being used for this project. If omitted, no framework is selected.
    functionFailover boolean
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    gitComments ProjectGitComments
    Configuration for Git Comments.
    gitForkProtection boolean
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    gitLfs boolean
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    gitRepository ProjectGitRepository
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignoreCommand string
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    installCommand string
    The install command for this project. If omitted, this value will be automatically detected.
    name string
    The desired name for the project.
    oidcTokenConfig ProjectOidcTokenConfig
    Configuration for OpenID Connect (OIDC) tokens.
    optionsAllowlist ProjectOptionsAllowlist
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    outputDirectory string
    The output directory of the project. If omitted, this value will be automatically detected.
    passwordProtection ProjectPasswordProtection
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    previewComments boolean
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritiseProductionBuilds boolean
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protectionBypassForAutomation boolean
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    protectionBypassForAutomationSecret string
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    publicSource boolean
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resourceConfig ProjectResourceConfig
    Resource Configuration for the project.
    rootDirectory string
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverlessFunctionRegion string
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skewProtection string
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    teamId string
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trustedIps ProjectTrustedIps
    Ensures only visitors from an allowed IP address can access your deployment.
    vercelAuthentication ProjectVercelAuthentication
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    auto_assign_custom_domains bool
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automatically_expose_system_environment_variables bool
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    build_command str
    The build command for this project. If omitted, this value will be automatically detected.
    customer_success_code_visibility bool
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    dev_command str
    The dev command for this project. If omitted, this value will be automatically detected.
    directory_listing bool
    If no index file is present within a directory, the directory contents will be displayed.
    environments Sequence[ProjectEnvironmentArgs]
    A set of Environment Variables that should be configured for the project.
    framework str
    The framework that is being used for this project. If omitted, no framework is selected.
    function_failover bool
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    git_comments ProjectGitCommentsArgs
    Configuration for Git Comments.
    git_fork_protection bool
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    git_lfs bool
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    git_repository ProjectGitRepositoryArgs
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignore_command str
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    install_command str
    The install command for this project. If omitted, this value will be automatically detected.
    name str
    The desired name for the project.
    oidc_token_config ProjectOidcTokenConfigArgs
    Configuration for OpenID Connect (OIDC) tokens.
    options_allowlist ProjectOptionsAllowlistArgs
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    output_directory str
    The output directory of the project. If omitted, this value will be automatically detected.
    password_protection ProjectPasswordProtectionArgs
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    preview_comments bool
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritise_production_builds bool
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protection_bypass_for_automation bool
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    protection_bypass_for_automation_secret str
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    public_source bool
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resource_config ProjectResourceConfigArgs
    Resource Configuration for the project.
    root_directory str
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverless_function_region str
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skew_protection str
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    team_id str
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trusted_ips ProjectTrustedIpsArgs
    Ensures only visitors from an allowed IP address can access your deployment.
    vercel_authentication ProjectVercelAuthenticationArgs
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
    autoAssignCustomDomains Boolean
    Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
    automaticallyExposeSystemEnvironmentVariables Boolean
    Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
    buildCommand String
    The build command for this project. If omitted, this value will be automatically detected.
    customerSuccessCodeVisibility Boolean
    Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
    devCommand String
    The dev command for this project. If omitted, this value will be automatically detected.
    directoryListing Boolean
    If no index file is present within a directory, the directory contents will be displayed.
    environments List<Property Map>
    A set of Environment Variables that should be configured for the project.
    framework String
    The framework that is being used for this project. If omitted, no framework is selected.
    functionFailover Boolean
    Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
    gitComments Property Map
    Configuration for Git Comments.
    gitForkProtection Boolean
    Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json. Defaults to true.
    gitLfs Boolean
    Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
    gitRepository Property Map
    The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
    ignoreCommand String
    When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
    installCommand String
    The install command for this project. If omitted, this value will be automatically detected.
    name String
    The desired name for the project.
    oidcTokenConfig Property Map
    Configuration for OpenID Connect (OIDC) tokens.
    optionsAllowlist Property Map
    Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
    outputDirectory String
    The output directory of the project. If omitted, this value will be automatically detected.
    passwordProtection Property Map
    Ensures visitors of your Preview Deployments must enter a password in order to gain access.
    previewComments Boolean
    Whether to enable comments on your Preview Deployments. If omitted, comments are controlled at the team level (default behaviour).
    prioritiseProductionBuilds Boolean
    If enabled, builds for the Production environment will be prioritized over Preview environments.
    protectionBypassForAutomation Boolean
    Allow automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass with a value of the password_protection_for_automation_secret field.
    protectionBypassForAutomationSecret String
    If protection_bypass_for_automation is enabled, use this value in the x-vercel-protection-bypass header to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments.
    publicSource Boolean
    By default, visitors to the /_logs and /_src paths of your Production and Preview Deployments must log in with Vercel (requires being a member of your team) to see the Source, Logs and Deployment Status of your project. Setting public_source to true disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed.
    resourceConfig Property Map
    Resource Configuration for the project.
    rootDirectory String
    The name of a directory or relative path to the source code of your project. If omitted, it will default to the project root.
    serverlessFunctionRegion String
    The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
    skewProtection String
    Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
    teamId String
    The team ID to add the project to. Required when configuring a team resource if a default team has not been set in the provider.
    trustedIps Property Map
    Ensures only visitors from an allowed IP address can access your deployment.
    vercelAuthentication Property Map
    Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

    Supporting Types

    ProjectEnvironment, ProjectEnvironmentArgs

    Key string
    The name of the Environment Variable.
    Targets List<string>
    The environments that the Environment Variable should be present on. Valid targets are either production, preview, or development.
    Value string
    The value of the Environment Variable.
    GitBranch string
    The git branch of the Environment Variable.
    Id string
    The ID of the Environment Variable.
    Sensitive bool
    Whether the Environment Variable is sensitive or not. (May be affected by a team-wide environment variable policy)
    Key string
    The name of the Environment Variable.
    Targets []string
    The environments that the Environment Variable should be present on. Valid targets are either production, preview, or development.
    Value string
    The value of the Environment Variable.
    GitBranch string
    The git branch of the Environment Variable.
    Id string
    The ID of the Environment Variable.
    Sensitive bool
    Whether the Environment Variable is sensitive or not. (May be affected by a team-wide environment variable policy)
    key String
    The name of the Environment Variable.
    targets List<String>
    The environments that the Environment Variable should be present on. Valid targets are either production, preview, or development.
    value String
    The value of the Environment Variable.
    gitBranch String
    The git branch of the Environment Variable.
    id String
    The ID of the Environment Variable.
    sensitive Boolean
    Whether the Environment Variable is sensitive or not. (May be affected by a team-wide environment variable policy)
    key string
    The name of the Environment Variable.
    targets string[]
    The environments that the Environment Variable should be present on. Valid targets are either production, preview, or development.
    value string
    The value of the Environment Variable.
    gitBranch string
    The git branch of the Environment Variable.
    id string
    The ID of the Environment Variable.
    sensitive boolean
    Whether the Environment Variable is sensitive or not. (May be affected by a team-wide environment variable policy)
    key str
    The name of the Environment Variable.
    targets Sequence[str]
    The environments that the Environment Variable should be present on. Valid targets are either production, preview, or development.
    value str
    The value of the Environment Variable.
    git_branch str
    The git branch of the Environment Variable.
    id str
    The ID of the Environment Variable.
    sensitive bool
    Whether the Environment Variable is sensitive or not. (May be affected by a team-wide environment variable policy)
    key String
    The name of the Environment Variable.
    targets List<String>
    The environments that the Environment Variable should be present on. Valid targets are either production, preview, or development.
    value String
    The value of the Environment Variable.
    gitBranch String
    The git branch of the Environment Variable.
    id String
    The ID of the Environment Variable.
    sensitive Boolean
    Whether the Environment Variable is sensitive or not. (May be affected by a team-wide environment variable policy)

    ProjectGitComments, ProjectGitCommentsArgs

    OnCommit bool
    Whether Commit comments are enabled
    OnPullRequest bool
    Whether Pull Request comments are enabled
    OnCommit bool
    Whether Commit comments are enabled
    OnPullRequest bool
    Whether Pull Request comments are enabled
    onCommit Boolean
    Whether Commit comments are enabled
    onPullRequest Boolean
    Whether Pull Request comments are enabled
    onCommit boolean
    Whether Commit comments are enabled
    onPullRequest boolean
    Whether Pull Request comments are enabled
    on_commit bool
    Whether Commit comments are enabled
    on_pull_request bool
    Whether Pull Request comments are enabled
    onCommit Boolean
    Whether Commit comments are enabled
    onPullRequest Boolean
    Whether Pull Request comments are enabled

    ProjectGitRepository, ProjectGitRepositoryArgs

    Repo string
    The name of the git repository. For example: vercel/next.js.
    Type string
    The git provider of the repository. Must be either github, gitlab, or bitbucket.
    DeployHooks List<Pulumiverse.Vercel.Inputs.ProjectGitRepositoryDeployHook>
    Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
    ProductionBranch string
    By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
    Repo string
    The name of the git repository. For example: vercel/next.js.
    Type string
    The git provider of the repository. Must be either github, gitlab, or bitbucket.
    DeployHooks []ProjectGitRepositoryDeployHook
    Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
    ProductionBranch string
    By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
    repo String
    The name of the git repository. For example: vercel/next.js.
    type String
    The git provider of the repository. Must be either github, gitlab, or bitbucket.
    deployHooks List<ProjectGitRepositoryDeployHook>
    Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
    productionBranch String
    By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
    repo string
    The name of the git repository. For example: vercel/next.js.
    type string
    The git provider of the repository. Must be either github, gitlab, or bitbucket.
    deployHooks ProjectGitRepositoryDeployHook[]
    Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
    productionBranch string
    By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
    repo str
    The name of the git repository. For example: vercel/next.js.
    type str
    The git provider of the repository. Must be either github, gitlab, or bitbucket.
    deploy_hooks Sequence[ProjectGitRepositoryDeployHook]
    Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
    production_branch str
    By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
    repo String
    The name of the git repository. For example: vercel/next.js.
    type String
    The git provider of the repository. Must be either github, gitlab, or bitbucket.
    deployHooks List<Property Map>
    Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
    productionBranch String
    By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.

    ProjectGitRepositoryDeployHook, ProjectGitRepositoryDeployHookArgs

    Name string
    The name of the deploy hook.
    Ref string
    The branch or commit hash that should be deployed.
    Id string
    The ID of the deploy hook.
    Url string
    A URL that, when a POST request is made to, will trigger a new deployment.
    Name string
    The name of the deploy hook.
    Ref string
    The branch or commit hash that should be deployed.
    Id string
    The ID of the deploy hook.
    Url string
    A URL that, when a POST request is made to, will trigger a new deployment.
    name String
    The name of the deploy hook.
    ref String
    The branch or commit hash that should be deployed.
    id String
    The ID of the deploy hook.
    url String
    A URL that, when a POST request is made to, will trigger a new deployment.
    name string
    The name of the deploy hook.
    ref string
    The branch or commit hash that should be deployed.
    id string
    The ID of the deploy hook.
    url string
    A URL that, when a POST request is made to, will trigger a new deployment.
    name str
    The name of the deploy hook.
    ref str
    The branch or commit hash that should be deployed.
    id str
    The ID of the deploy hook.
    url str
    A URL that, when a POST request is made to, will trigger a new deployment.
    name String
    The name of the deploy hook.
    ref String
    The branch or commit hash that should be deployed.
    id String
    The ID of the deploy hook.
    url String
    A URL that, when a POST request is made to, will trigger a new deployment.

    ProjectOidcTokenConfig, ProjectOidcTokenConfigArgs

    Enabled bool
    When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
    Enabled bool
    When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
    enabled Boolean
    When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
    enabled boolean
    When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
    enabled bool
    When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.
    enabled Boolean
    When true, Vercel issued OpenID Connect (OIDC) tokens will be available on the compute environments. See https://vercel.com/docs/security/secure-backend-access/oidc for more information.

    ProjectOptionsAllowlist, ProjectOptionsAllowlistArgs

    Paths List<Pulumiverse.Vercel.Inputs.ProjectOptionsAllowlistPath>
    The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.
    Paths []ProjectOptionsAllowlistPath
    The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.
    paths List<ProjectOptionsAllowlistPath>
    The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.
    paths ProjectOptionsAllowlistPath[]
    The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.
    paths Sequence[ProjectOptionsAllowlistPath]
    The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.
    paths List<Property Map>
    The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.

    ProjectOptionsAllowlistPath, ProjectOptionsAllowlistPathArgs

    Value string
    The path prefix to compare with the incoming request path.
    Value string
    The path prefix to compare with the incoming request path.
    value String
    The path prefix to compare with the incoming request path.
    value string
    The path prefix to compare with the incoming request path.
    value str
    The path prefix to compare with the incoming request path.
    value String
    The path prefix to compare with the incoming request path.

    ProjectPasswordProtection, ProjectPasswordProtectionArgs

    DeploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, or only_preview_deployments.
    Password string
    The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
    DeploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, or only_preview_deployments.
    Password string
    The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
    deploymentType String
    The deployment environment to protect. Must be one of standard_protection, all_deployments, or only_preview_deployments.
    password String
    The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
    deploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, or only_preview_deployments.
    password string
    The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
    deployment_type str
    The deployment environment to protect. Must be one of standard_protection, all_deployments, or only_preview_deployments.
    password str
    The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.
    deploymentType String
    The deployment environment to protect. Must be one of standard_protection, all_deployments, or only_preview_deployments.
    password String
    The password that visitors must enter to gain access to your Preview Deployments. Drift detection is not possible for this field.

    ProjectResourceConfig, ProjectResourceConfigArgs

    FunctionDefaultCpuType string
    The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
    FunctionDefaultTimeout int
    The default timeout for Serverless Functions.
    FunctionDefaultCpuType string
    The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
    FunctionDefaultTimeout int
    The default timeout for Serverless Functions.
    functionDefaultCpuType String
    The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
    functionDefaultTimeout Integer
    The default timeout for Serverless Functions.
    functionDefaultCpuType string
    The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
    functionDefaultTimeout number
    The default timeout for Serverless Functions.
    function_default_cpu_type str
    The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
    function_default_timeout int
    The default timeout for Serverless Functions.
    functionDefaultCpuType String
    The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
    functionDefaultTimeout Number
    The default timeout for Serverless Functions.

    ProjectTrustedIps, ProjectTrustedIpsArgs

    Addresses List<Pulumiverse.Vercel.Inputs.ProjectTrustedIpsAddress>
    The allowed IP addressses and CIDR ranges with optional descriptions.
    DeploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_production_deployments, or only_preview_deployments.
    ProtectionMode string
    Whether or not Trusted IPs is optional to access a deployment. Must be either trusted_ip_required or trusted_ip_optional. trusted_ip_optional is only available with Standalone Trusted IPs.
    Addresses []ProjectTrustedIpsAddress
    The allowed IP addressses and CIDR ranges with optional descriptions.
    DeploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_production_deployments, or only_preview_deployments.
    ProtectionMode string
    Whether or not Trusted IPs is optional to access a deployment. Must be either trusted_ip_required or trusted_ip_optional. trusted_ip_optional is only available with Standalone Trusted IPs.
    addresses List<ProjectTrustedIpsAddress>
    The allowed IP addressses and CIDR ranges with optional descriptions.
    deploymentType String
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_production_deployments, or only_preview_deployments.
    protectionMode String
    Whether or not Trusted IPs is optional to access a deployment. Must be either trusted_ip_required or trusted_ip_optional. trusted_ip_optional is only available with Standalone Trusted IPs.
    addresses ProjectTrustedIpsAddress[]
    The allowed IP addressses and CIDR ranges with optional descriptions.
    deploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_production_deployments, or only_preview_deployments.
    protectionMode string
    Whether or not Trusted IPs is optional to access a deployment. Must be either trusted_ip_required or trusted_ip_optional. trusted_ip_optional is only available with Standalone Trusted IPs.
    addresses Sequence[ProjectTrustedIpsAddress]
    The allowed IP addressses and CIDR ranges with optional descriptions.
    deployment_type str
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_production_deployments, or only_preview_deployments.
    protection_mode str
    Whether or not Trusted IPs is optional to access a deployment. Must be either trusted_ip_required or trusted_ip_optional. trusted_ip_optional is only available with Standalone Trusted IPs.
    addresses List<Property Map>
    The allowed IP addressses and CIDR ranges with optional descriptions.
    deploymentType String
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_production_deployments, or only_preview_deployments.
    protectionMode String
    Whether or not Trusted IPs is optional to access a deployment. Must be either trusted_ip_required or trusted_ip_optional. trusted_ip_optional is only available with Standalone Trusted IPs.

    ProjectTrustedIpsAddress, ProjectTrustedIpsAddressArgs

    Value string
    The address or CIDR range that can access deployments.
    Note string
    A description for the value
    Value string
    The address or CIDR range that can access deployments.
    Note string
    A description for the value
    value String
    The address or CIDR range that can access deployments.
    note String
    A description for the value
    value string
    The address or CIDR range that can access deployments.
    note string
    A description for the value
    value str
    The address or CIDR range that can access deployments.
    note str
    A description for the value
    value String
    The address or CIDR range that can access deployments.
    note String
    A description for the value

    ProjectVercelAuthentication, ProjectVercelAuthenticationArgs

    DeploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_preview_deployments, or none.
    DeploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_preview_deployments, or none.
    deploymentType String
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_preview_deployments, or none.
    deploymentType string
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_preview_deployments, or none.
    deployment_type str
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_preview_deployments, or none.
    deploymentType String
    The deployment environment to protect. Must be one of standard_protection, all_deployments, only_preview_deployments, or none.

    Import

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

    the provider, simply use the project ID.

    • project_id can be found in the project settings tab in the Vercel UI.
    $ pulumi import vercel:index/project:Project example prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx

    Alternatively, you can import via the team_id and project_id.

    • team_id can be found in the team settings tab in the Vercel UI.

    • project_id can be found in the project settings tab in the Vercel UI.

    $ pulumi import vercel:index/project:Project example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_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.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
    pulumiverse/pulumi-vercel