vercel.Project
Explore with Pulumi AI
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("with_git", {
name: "example-project-with-git",
framework: "nextjs",
gitRepository: {
type: "github",
repo: "vercel/some-repo",
},
});
// 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", {
name: "example-project",
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("with_git",
name="example-project-with-git",
framework="nextjs",
git_repository={
"type": "github",
"repo": "vercel/some-repo",
})
# 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",
name="example-project",
framework="nextjs")
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/v3/go/vercel"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// 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, "with_git", &vercel.ProjectArgs{
Name: pulumi.String("example-project-with-git"),
Framework: pulumi.String("nextjs"),
GitRepository: &vercel.ProjectGitRepositoryArgs{
Type: pulumi.String("github"),
Repo: pulumi.String("vercel/some-repo"),
},
})
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{
Name: pulumi.String("example-project"),
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("with_git", new()
{
Name = "example-project-with-git",
Framework = "nextjs",
GitRepository = new Vercel.Inputs.ProjectGitRepositoryArgs
{
Type = "github",
Repo = "vercel/some-repo",
},
});
// 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()
{
Name = "example-project",
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()
.name("example-project-with-git")
.framework("nextjs")
.gitRepository(ProjectGitRepositoryArgs.builder()
.type("github")
.repo("vercel/some-repo")
.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()
.name("example-project")
.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
name: with_git
properties:
name: example-project-with-git
framework: nextjs
gitRepository:
type: github
repo: vercel/some-repo
# 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:
name: example-project
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,
enable_affected_projects_deployments: Optional[bool] = None,
enable_preview_feedback: Optional[bool] = None,
enable_production_feedback: 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,
node_version: Optional[str] = None,
oidc_token_config: Optional[ProjectOidcTokenConfigArgs] = None,
on_demand_concurrent_builds: Optional[bool] = 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)
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,
EnableAffectedProjectsDeployments = false,
EnablePreviewFeedback = false,
EnableProductionFeedback = false,
Environments = new[]
{
new Vercel.Inputs.ProjectEnvironmentArgs
{
Key = "string",
Value = "string",
Comment = "string",
CustomEnvironmentIds = new[]
{
"string",
},
GitBranch = "string",
Id = "string",
Sensitive = false,
Targets = new[]
{
"string",
},
},
},
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",
NodeVersion = "string",
OidcTokenConfig = new Vercel.Inputs.ProjectOidcTokenConfigArgs
{
Enabled = false,
IssuerMode = "string",
},
OnDemandConcurrentBuilds = 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",
},
PrioritiseProductionBuilds = false,
ProtectionBypassForAutomation = false,
ProtectionBypassForAutomationSecret = "string",
PublicSource = false,
ResourceConfig = new Vercel.Inputs.ProjectResourceConfigArgs
{
Fluid = false,
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),
EnableAffectedProjectsDeployments: pulumi.Bool(false),
EnablePreviewFeedback: pulumi.Bool(false),
EnableProductionFeedback: pulumi.Bool(false),
Environments: vercel.ProjectEnvironmentArray{
&vercel.ProjectEnvironmentArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Comment: pulumi.String("string"),
CustomEnvironmentIds: pulumi.StringArray{
pulumi.String("string"),
},
GitBranch: pulumi.String("string"),
Id: pulumi.String("string"),
Sensitive: pulumi.Bool(false),
Targets: pulumi.StringArray{
pulumi.String("string"),
},
},
},
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"),
NodeVersion: pulumi.String("string"),
OidcTokenConfig: &vercel.ProjectOidcTokenConfigArgs{
Enabled: pulumi.Bool(false),
IssuerMode: pulumi.String("string"),
},
OnDemandConcurrentBuilds: 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"),
},
PrioritiseProductionBuilds: pulumi.Bool(false),
ProtectionBypassForAutomation: pulumi.Bool(false),
ProtectionBypassForAutomationSecret: pulumi.String("string"),
PublicSource: pulumi.Bool(false),
ResourceConfig: &vercel.ProjectResourceConfigArgs{
Fluid: pulumi.Bool(false),
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)
.enableAffectedProjectsDeployments(false)
.enablePreviewFeedback(false)
.enableProductionFeedback(false)
.environments(ProjectEnvironmentArgs.builder()
.key("string")
.value("string")
.comment("string")
.customEnvironmentIds("string")
.gitBranch("string")
.id("string")
.sensitive(false)
.targets("string")
.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")
.nodeVersion("string")
.oidcTokenConfig(ProjectOidcTokenConfigArgs.builder()
.enabled(false)
.issuerMode("string")
.build())
.onDemandConcurrentBuilds(false)
.optionsAllowlist(ProjectOptionsAllowlistArgs.builder()
.paths(ProjectOptionsAllowlistPathArgs.builder()
.value("string")
.build())
.build())
.outputDirectory("string")
.passwordProtection(ProjectPasswordProtectionArgs.builder()
.deploymentType("string")
.password("string")
.build())
.prioritiseProductionBuilds(false)
.protectionBypassForAutomation(false)
.protectionBypassForAutomationSecret("string")
.publicSource(false)
.resourceConfig(ProjectResourceConfigArgs.builder()
.fluid(false)
.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,
enable_affected_projects_deployments=False,
enable_preview_feedback=False,
enable_production_feedback=False,
environments=[{
"key": "string",
"value": "string",
"comment": "string",
"custom_environment_ids": ["string"],
"git_branch": "string",
"id": "string",
"sensitive": False,
"targets": ["string"],
}],
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",
node_version="string",
oidc_token_config={
"enabled": False,
"issuer_mode": "string",
},
on_demand_concurrent_builds=False,
options_allowlist={
"paths": [{
"value": "string",
}],
},
output_directory="string",
password_protection={
"deployment_type": "string",
"password": "string",
},
prioritise_production_builds=False,
protection_bypass_for_automation=False,
protection_bypass_for_automation_secret="string",
public_source=False,
resource_config={
"fluid": False,
"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,
enableAffectedProjectsDeployments: false,
enablePreviewFeedback: false,
enableProductionFeedback: false,
environments: [{
key: "string",
value: "string",
comment: "string",
customEnvironmentIds: ["string"],
gitBranch: "string",
id: "string",
sensitive: false,
targets: ["string"],
}],
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",
nodeVersion: "string",
oidcTokenConfig: {
enabled: false,
issuerMode: "string",
},
onDemandConcurrentBuilds: false,
optionsAllowlist: {
paths: [{
value: "string",
}],
},
outputDirectory: "string",
passwordProtection: {
deploymentType: "string",
password: "string",
},
prioritiseProductionBuilds: false,
protectionBypassForAutomation: false,
protectionBypassForAutomationSecret: "string",
publicSource: false,
resourceConfig: {
fluid: false,
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
enableAffectedProjectsDeployments: false
enablePreviewFeedback: false
enableProductionFeedback: false
environments:
- comment: string
customEnvironmentIds:
- string
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
nodeVersion: string
oidcTokenConfig:
enabled: false
issuerMode: string
onDemandConcurrentBuilds: false
optionsAllowlist:
paths:
- value: string
outputDirectory: string
passwordProtection:
deploymentType: string
password: string
prioritiseProductionBuilds: false
protectionBypassForAutomation: false
protectionBypassForAutomationSecret: string
publicSource: false
resourceConfig:
fluid: false
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:
- Auto
Assign boolCustom Domains - 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 boolSystem Environment Variables - 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 string - The build command for this project. If omitted, this value will be automatically detected.
- Customer
Success boolCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- Dev
Command string - 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.
- Enable
Affected boolProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- Enable
Preview boolFeedback - Enables the Vercel Toolbar on your preview deployments.
- Enable
Production boolFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- Environments
List<Pulumiverse.
Vercel. Inputs. Project Environment> - 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.
- 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 Pulumiverse.Vercel. Inputs. Project Git Comments - Configuration for Git Comments.
- Git
Fork boolProtection - 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 Pulumiverse.Vercel. Inputs. Project Git Repository - 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 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.
- Install
Command string - The install command for this project. If omitted, this value will be automatically detected.
- Name string
- The desired name for the project.
- Node
Version string - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- Oidc
Token Pulumiverse.Config Vercel. Inputs. Project Oidc Token Config - Configuration for OpenID Connect (OIDC) tokens.
- On
Demand boolConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- Options
Allowlist Pulumiverse.Vercel. Inputs. Project Options Allowlist - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - Output
Directory string - The output directory of the project. If omitted, this value will be automatically detected.
- Password
Protection Pulumiverse.Vercel. Inputs. Project Password Protection - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- Preview
Comments bool - Enables the Vercel Toolbar on your preview deployments.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protection
Bypass boolFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - Protection
Bypass stringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - Resource
Config Pulumiverse.Vercel. Inputs. Project Resource Config - Resource Configuration for the project.
- Root
Directory 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.
- Serverless
Function stringRegion - 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 string - 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 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.
- Trusted
Ips Pulumiverse.Vercel. Inputs. Project Trusted Ips - Ensures only visitors from an allowed IP address can access your deployment.
- Vercel
Authentication Pulumiverse.Vercel. Inputs. Project Vercel Authentication - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- Auto
Assign boolCustom Domains - 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 boolSystem Environment Variables - 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 string - The build command for this project. If omitted, this value will be automatically detected.
- Customer
Success boolCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- Dev
Command string - 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.
- Enable
Affected boolProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- Enable
Preview boolFeedback - Enables the Vercel Toolbar on your preview deployments.
- Enable
Production boolFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- Environments
[]Project
Environment Args - 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.
- 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 ProjectGit Comments Args - Configuration for Git Comments.
- Git
Fork boolProtection - 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 ProjectGit Repository Args - 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 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.
- Install
Command string - The install command for this project. If omitted, this value will be automatically detected.
- Name string
- The desired name for the project.
- Node
Version string - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- Oidc
Token ProjectConfig Oidc Token Config Args - Configuration for OpenID Connect (OIDC) tokens.
- On
Demand boolConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- Options
Allowlist ProjectOptions Allowlist Args - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - Output
Directory string - The output directory of the project. If omitted, this value will be automatically detected.
- Password
Protection ProjectPassword Protection Args - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- Preview
Comments bool - Enables the Vercel Toolbar on your preview deployments.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protection
Bypass boolFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - Protection
Bypass stringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - Resource
Config ProjectResource Config Args - Resource Configuration for the project.
- Root
Directory 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.
- Serverless
Function stringRegion - 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 string - 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 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.
- Trusted
Ips ProjectTrusted Ips Args - Ensures only visitors from an allowed IP address can access your deployment.
- Vercel
Authentication ProjectVercel Authentication Args - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto
Assign BooleanCustom Domains - 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 BooleanSystem Environment Variables - 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 String - The build command for this project. If omitted, this value will be automatically detected.
- customer
Success BooleanCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- dev
Command String - The dev command for this project. If omitted, this value will be automatically detected.
- directory
Listing Boolean - If no index file is present within a directory, the directory contents will be displayed.
- enable
Affected BooleanProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable
Preview BooleanFeedback - Enables the Vercel Toolbar on your preview deployments.
- enable
Production BooleanFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- environments
List<Project
Environment> - 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.
- function
Failover 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.
- git
Comments ProjectGit Comments - Configuration for Git Comments.
- git
Fork BooleanProtection - 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 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.
- git
Repository ProjectGit Repository - 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 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.
- install
Command String - The install command for this project. If omitted, this value will be automatically detected.
- name String
- The desired name for the project.
- node
Version String - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc
Token ProjectConfig Oidc Token Config - Configuration for OpenID Connect (OIDC) tokens.
- on
Demand BooleanConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options
Allowlist ProjectOptions Allowlist - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - output
Directory String - The output directory of the project. If omitted, this value will be automatically detected.
- password
Protection ProjectPassword Protection - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview
Comments Boolean - Enables the Vercel Toolbar on your preview deployments.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection
Bypass BooleanFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection
Bypass StringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - public
Source 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource
Config ProjectResource Config - Resource Configuration for the project.
- root
Directory 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.
- serverless
Function StringRegion - 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 String - 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 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.
- trusted
Ips ProjectTrusted Ips - Ensures only visitors from an allowed IP address can access your deployment.
- vercel
Authentication ProjectVercel Authentication - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto
Assign booleanCustom Domains - 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 booleanSystem Environment Variables - 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 string - The build command for this project. If omitted, this value will be automatically detected.
- customer
Success booleanCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- dev
Command string - The dev command for this project. If omitted, this value will be automatically detected.
- directory
Listing boolean - If no index file is present within a directory, the directory contents will be displayed.
- enable
Affected booleanProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable
Preview booleanFeedback - Enables the Vercel Toolbar on your preview deployments.
- enable
Production booleanFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- environments
Project
Environment[] - 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.
- function
Failover 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.
- git
Comments ProjectGit Comments - Configuration for Git Comments.
- git
Fork booleanProtection - 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 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.
- git
Repository ProjectGit Repository - 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 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.
- install
Command string - The install command for this project. If omitted, this value will be automatically detected.
- name string
- The desired name for the project.
- node
Version string - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc
Token ProjectConfig Oidc Token Config - Configuration for OpenID Connect (OIDC) tokens.
- on
Demand booleanConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options
Allowlist ProjectOptions Allowlist - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - output
Directory string - The output directory of the project. If omitted, this value will be automatically detected.
- password
Protection ProjectPassword Protection - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview
Comments boolean - Enables the Vercel Toolbar on your preview deployments.
- prioritise
Production booleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection
Bypass booleanFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection
Bypass stringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - public
Source 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource
Config ProjectResource Config - Resource Configuration for the project.
- root
Directory 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.
- serverless
Function stringRegion - 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 string - 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 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.
- trusted
Ips ProjectTrusted Ips - Ensures only visitors from an allowed IP address can access your deployment.
- vercel
Authentication ProjectVercel Authentication - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto_
assign_ boolcustom_ domains - 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_ boolsystem_ environment_ variables - 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_ boolcode_ visibility - 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.
- enable_
affected_ boolprojects_ deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable_
preview_ boolfeedback - Enables the Vercel Toolbar on your preview deployments.
- enable_
production_ boolfeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- environments
Sequence[Project
Environment Args] - 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 ProjectGit Comments Args - Configuration for Git Comments.
- git_
fork_ boolprotection - 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 ProjectGit Repository Args - 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.
- node_
version str - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc_
token_ Projectconfig Oidc Token Config Args - Configuration for OpenID Connect (OIDC) tokens.
- on_
demand_ boolconcurrent_ builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options_
allowlist ProjectOptions Allowlist Args - 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 ProjectPassword Protection Args - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview_
comments bool - Enables the Vercel Toolbar on your preview deployments.
- prioritise_
production_ boolbuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection_
bypass_ boolfor_ automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection_
bypass_ strfor_ automation_ secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource_
config ProjectResource Config Args - 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_ strregion - 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 ProjectTrusted Ips Args - Ensures only visitors from an allowed IP address can access your deployment.
- vercel_
authentication ProjectVercel Authentication Args - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto
Assign BooleanCustom Domains - 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 BooleanSystem Environment Variables - 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 String - The build command for this project. If omitted, this value will be automatically detected.
- customer
Success BooleanCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- dev
Command String - The dev command for this project. If omitted, this value will be automatically detected.
- directory
Listing Boolean - If no index file is present within a directory, the directory contents will be displayed.
- enable
Affected BooleanProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable
Preview BooleanFeedback - Enables the Vercel Toolbar on your preview deployments.
- enable
Production BooleanFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- 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.
- function
Failover 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.
- git
Comments Property Map - Configuration for Git Comments.
- git
Fork BooleanProtection - 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 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.
- git
Repository 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.
- ignore
Command 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.
- install
Command String - The install command for this project. If omitted, this value will be automatically detected.
- name String
- The desired name for the project.
- node
Version String - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc
Token Property MapConfig - Configuration for OpenID Connect (OIDC) tokens.
- on
Demand BooleanConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options
Allowlist Property Map - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - output
Directory String - The output directory of the project. If omitted, this value will be automatically detected.
- password
Protection Property Map - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview
Comments Boolean - Enables the Vercel Toolbar on your preview deployments.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection
Bypass BooleanFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection
Bypass StringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - public
Source 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource
Config Property Map - Resource Configuration for the project.
- root
Directory 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.
- serverless
Function StringRegion - 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 String - 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 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.
- trusted
Ips Property Map - Ensures only visitors from an allowed IP address can access your deployment.
- vercel
Authentication 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.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing 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,
enable_affected_projects_deployments: Optional[bool] = None,
enable_preview_feedback: Optional[bool] = None,
enable_production_feedback: 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,
node_version: Optional[str] = None,
oidc_token_config: Optional[ProjectOidcTokenConfigArgs] = None,
on_demand_concurrent_builds: Optional[bool] = 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)
resources: _: type: vercel:Project get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Auto
Assign boolCustom Domains - 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 boolSystem Environment Variables - 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 string - The build command for this project. If omitted, this value will be automatically detected.
- Customer
Success boolCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- Dev
Command string - 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.
- Enable
Affected boolProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- Enable
Preview boolFeedback - Enables the Vercel Toolbar on your preview deployments.
- Enable
Production boolFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- Environments
List<Pulumiverse.
Vercel. Inputs. Project Environment> - 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.
- 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 Pulumiverse.Vercel. Inputs. Project Git Comments - Configuration for Git Comments.
- Git
Fork boolProtection - 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 Pulumiverse.Vercel. Inputs. Project Git Repository - 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 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.
- Install
Command string - The install command for this project. If omitted, this value will be automatically detected.
- Name string
- The desired name for the project.
- Node
Version string - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- Oidc
Token Pulumiverse.Config Vercel. Inputs. Project Oidc Token Config - Configuration for OpenID Connect (OIDC) tokens.
- On
Demand boolConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- Options
Allowlist Pulumiverse.Vercel. Inputs. Project Options Allowlist - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - Output
Directory string - The output directory of the project. If omitted, this value will be automatically detected.
- Password
Protection Pulumiverse.Vercel. Inputs. Project Password Protection - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- Preview
Comments bool - Enables the Vercel Toolbar on your preview deployments.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protection
Bypass boolFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - Protection
Bypass stringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - Resource
Config Pulumiverse.Vercel. Inputs. Project Resource Config - Resource Configuration for the project.
- Root
Directory 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.
- Serverless
Function stringRegion - 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 string - 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 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.
- Trusted
Ips Pulumiverse.Vercel. Inputs. Project Trusted Ips - Ensures only visitors from an allowed IP address can access your deployment.
- Vercel
Authentication Pulumiverse.Vercel. Inputs. Project Vercel Authentication - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- Auto
Assign boolCustom Domains - 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 boolSystem Environment Variables - 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 string - The build command for this project. If omitted, this value will be automatically detected.
- Customer
Success boolCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- Dev
Command string - 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.
- Enable
Affected boolProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- Enable
Preview boolFeedback - Enables the Vercel Toolbar on your preview deployments.
- Enable
Production boolFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- Environments
[]Project
Environment Args - 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.
- 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 ProjectGit Comments Args - Configuration for Git Comments.
- Git
Fork boolProtection - 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 ProjectGit Repository Args - 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 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.
- Install
Command string - The install command for this project. If omitted, this value will be automatically detected.
- Name string
- The desired name for the project.
- Node
Version string - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- Oidc
Token ProjectConfig Oidc Token Config Args - Configuration for OpenID Connect (OIDC) tokens.
- On
Demand boolConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- Options
Allowlist ProjectOptions Allowlist Args - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - Output
Directory string - The output directory of the project. If omitted, this value will be automatically detected.
- Password
Protection ProjectPassword Protection Args - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- Preview
Comments bool - Enables the Vercel Toolbar on your preview deployments.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protection
Bypass boolFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - Protection
Bypass stringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - Resource
Config ProjectResource Config Args - Resource Configuration for the project.
- Root
Directory 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.
- Serverless
Function stringRegion - 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 string - 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 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.
- Trusted
Ips ProjectTrusted Ips Args - Ensures only visitors from an allowed IP address can access your deployment.
- Vercel
Authentication ProjectVercel Authentication Args - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto
Assign BooleanCustom Domains - 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 BooleanSystem Environment Variables - 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 String - The build command for this project. If omitted, this value will be automatically detected.
- customer
Success BooleanCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- dev
Command String - The dev command for this project. If omitted, this value will be automatically detected.
- directory
Listing Boolean - If no index file is present within a directory, the directory contents will be displayed.
- enable
Affected BooleanProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable
Preview BooleanFeedback - Enables the Vercel Toolbar on your preview deployments.
- enable
Production BooleanFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- environments
List<Project
Environment> - 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.
- function
Failover 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.
- git
Comments ProjectGit Comments - Configuration for Git Comments.
- git
Fork BooleanProtection - 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 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.
- git
Repository ProjectGit Repository - 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 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.
- install
Command String - The install command for this project. If omitted, this value will be automatically detected.
- name String
- The desired name for the project.
- node
Version String - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc
Token ProjectConfig Oidc Token Config - Configuration for OpenID Connect (OIDC) tokens.
- on
Demand BooleanConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options
Allowlist ProjectOptions Allowlist - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - output
Directory String - The output directory of the project. If omitted, this value will be automatically detected.
- password
Protection ProjectPassword Protection - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview
Comments Boolean - Enables the Vercel Toolbar on your preview deployments.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection
Bypass BooleanFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection
Bypass StringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - public
Source 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource
Config ProjectResource Config - Resource Configuration for the project.
- root
Directory 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.
- serverless
Function StringRegion - 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 String - 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 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.
- trusted
Ips ProjectTrusted Ips - Ensures only visitors from an allowed IP address can access your deployment.
- vercel
Authentication ProjectVercel Authentication - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto
Assign booleanCustom Domains - 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 booleanSystem Environment Variables - 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 string - The build command for this project. If omitted, this value will be automatically detected.
- customer
Success booleanCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- dev
Command string - The dev command for this project. If omitted, this value will be automatically detected.
- directory
Listing boolean - If no index file is present within a directory, the directory contents will be displayed.
- enable
Affected booleanProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable
Preview booleanFeedback - Enables the Vercel Toolbar on your preview deployments.
- enable
Production booleanFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- environments
Project
Environment[] - 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.
- function
Failover 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.
- git
Comments ProjectGit Comments - Configuration for Git Comments.
- git
Fork booleanProtection - 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 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.
- git
Repository ProjectGit Repository - 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 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.
- install
Command string - The install command for this project. If omitted, this value will be automatically detected.
- name string
- The desired name for the project.
- node
Version string - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc
Token ProjectConfig Oidc Token Config - Configuration for OpenID Connect (OIDC) tokens.
- on
Demand booleanConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options
Allowlist ProjectOptions Allowlist - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - output
Directory string - The output directory of the project. If omitted, this value will be automatically detected.
- password
Protection ProjectPassword Protection - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview
Comments boolean - Enables the Vercel Toolbar on your preview deployments.
- prioritise
Production booleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection
Bypass booleanFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection
Bypass stringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - public
Source 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource
Config ProjectResource Config - Resource Configuration for the project.
- root
Directory 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.
- serverless
Function stringRegion - 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 string - 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 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.
- trusted
Ips ProjectTrusted Ips - Ensures only visitors from an allowed IP address can access your deployment.
- vercel
Authentication ProjectVercel Authentication - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto_
assign_ boolcustom_ domains - 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_ boolsystem_ environment_ variables - 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_ boolcode_ visibility - 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.
- enable_
affected_ boolprojects_ deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable_
preview_ boolfeedback - Enables the Vercel Toolbar on your preview deployments.
- enable_
production_ boolfeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- environments
Sequence[Project
Environment Args] - 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 ProjectGit Comments Args - Configuration for Git Comments.
- git_
fork_ boolprotection - 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 ProjectGit Repository Args - 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.
- node_
version str - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc_
token_ Projectconfig Oidc Token Config Args - Configuration for OpenID Connect (OIDC) tokens.
- on_
demand_ boolconcurrent_ builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options_
allowlist ProjectOptions Allowlist Args - 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 ProjectPassword Protection Args - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview_
comments bool - Enables the Vercel Toolbar on your preview deployments.
- prioritise_
production_ boolbuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection_
bypass_ boolfor_ automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection_
bypass_ strfor_ automation_ secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource_
config ProjectResource Config Args - 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_ strregion - 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 ProjectTrusted Ips Args - Ensures only visitors from an allowed IP address can access your deployment.
- vercel_
authentication ProjectVercel Authentication Args - Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.
- auto
Assign BooleanCustom Domains - 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 BooleanSystem Environment Variables - 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 String - The build command for this project. If omitted, this value will be automatically detected.
- customer
Success BooleanCode Visibility - Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
- dev
Command String - The dev command for this project. If omitted, this value will be automatically detected.
- directory
Listing Boolean - If no index file is present within a directory, the directory contents will be displayed.
- enable
Affected BooleanProjects Deployments - When enabled, Vercel will automatically deploy all projects that are affected by a change to this project.
- enable
Preview BooleanFeedback - Enables the Vercel Toolbar on your preview deployments.
- enable
Production BooleanFeedback - Enables the Vercel Toolbar on your production deployments: one of on, off or default.
- 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.
- function
Failover 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.
- git
Comments Property Map - Configuration for Git Comments.
- git
Fork BooleanProtection - 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 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.
- git
Repository 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.
- ignore
Command 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.
- install
Command String - The install command for this project. If omitted, this value will be automatically detected.
- name String
- The desired name for the project.
- node
Version String - The version of Node.js that is used in the Build Step and for Serverless Functions. A new Deployment is required for your changes to take effect.
- oidc
Token Property MapConfig - Configuration for OpenID Connect (OIDC) tokens.
- on
Demand BooleanConcurrent Builds - Instantly scale build capacity to skip the queue, even if all build slots are in use. You can also choose a larger build machine; charges apply per minute if it exceeds your team's default.
- options
Allowlist Property Map - Disable Deployment Protection for CORS preflight
OPTIONS
requests for a list of paths. - output
Directory String - The output directory of the project. If omitted, this value will be automatically detected.
- password
Protection Property Map - Ensures visitors of your Preview Deployments must enter a password in order to gain access.
- preview
Comments Boolean - Enables the Vercel Toolbar on your preview deployments.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protection
Bypass BooleanFor Automation - Allow automation services to bypass Deployment Protection on this project when using an HTTP header named
x-vercel-protection-bypass
with a value of theprotection_bypass_for_automation_secret
field. - protection
Bypass StringFor Automation Secret - If
protection_bypass_for_automation
is enabled, optionally set this value to specify a 32 character secret, otherwise a secret will be generated. - public
Source 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. Settingpublic_source
totrue
disables this behaviour, meaning the Source, Logs and Deployment Status can be publicly viewed. - resource
Config Property Map - Resource Configuration for the project.
- root
Directory 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.
- serverless
Function StringRegion - 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 String - 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 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.
- trusted
Ips Property Map - Ensures only visitors from an allowed IP address can access your deployment.
- vercel
Authentication 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.
- Value string
- The value of the Environment Variable.
- Comment string
- A comment explaining what the environment variable is for.
- Custom
Environment List<string>Ids - The IDs of Custom Environments that the Environment Variable should be present on. At least one of
target
orcustom_environment_ids
must be set. - Git
Branch 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)
- Targets List<string>
- The environments that the Environment Variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. At least one oftarget
orcustom_environment_ids
must be set.
- Key string
- The name of the Environment Variable.
- Value string
- The value of the Environment Variable.
- Comment string
- A comment explaining what the environment variable is for.
- Custom
Environment []stringIds - The IDs of Custom Environments that the Environment Variable should be present on. At least one of
target
orcustom_environment_ids
must be set. - Git
Branch 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)
- Targets []string
- The environments that the Environment Variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. At least one oftarget
orcustom_environment_ids
must be set.
- key String
- The name of the Environment Variable.
- value String
- The value of the Environment Variable.
- comment String
- A comment explaining what the environment variable is for.
- custom
Environment List<String>Ids - The IDs of Custom Environments that the Environment Variable should be present on. At least one of
target
orcustom_environment_ids
must be set. - git
Branch 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)
- targets List<String>
- The environments that the Environment Variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. At least one oftarget
orcustom_environment_ids
must be set.
- key string
- The name of the Environment Variable.
- value string
- The value of the Environment Variable.
- comment string
- A comment explaining what the environment variable is for.
- custom
Environment string[]Ids - The IDs of Custom Environments that the Environment Variable should be present on. At least one of
target
orcustom_environment_ids
must be set. - git
Branch 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)
- targets string[]
- The environments that the Environment Variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. At least one oftarget
orcustom_environment_ids
must be set.
- key str
- The name of the Environment Variable.
- value str
- The value of the Environment Variable.
- comment str
- A comment explaining what the environment variable is for.
- custom_
environment_ Sequence[str]ids - The IDs of Custom Environments that the Environment Variable should be present on. At least one of
target
orcustom_environment_ids
must be set. - 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)
- targets Sequence[str]
- The environments that the Environment Variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. At least one oftarget
orcustom_environment_ids
must be set.
- key String
- The name of the Environment Variable.
- value String
- The value of the Environment Variable.
- comment String
- A comment explaining what the environment variable is for.
- custom
Environment List<String>Ids - The IDs of Custom Environments that the Environment Variable should be present on. At least one of
target
orcustom_environment_ids
must be set. - git
Branch 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)
- targets List<String>
- The environments that the Environment Variable should be present on. Valid targets are either
production
,preview
, ordevelopment
. At least one oftarget
orcustom_environment_ids
must be set.
ProjectGitComments, ProjectGitCommentsArgs
- On
Commit bool - Whether Commit comments are enabled
- On
Pull boolRequest - Whether Pull Request comments are enabled
- On
Commit bool - Whether Commit comments are enabled
- On
Pull boolRequest - Whether Pull Request comments are enabled
- on
Commit Boolean - Whether Commit comments are enabled
- on
Pull BooleanRequest - Whether Pull Request comments are enabled
- on
Commit boolean - Whether Commit comments are enabled
- on
Pull booleanRequest - Whether Pull Request comments are enabled
- on_
commit bool - Whether Commit comments are enabled
- on_
pull_ boolrequest - Whether Pull Request comments are enabled
- on
Commit Boolean - Whether Commit comments are enabled
- on
Pull BooleanRequest - 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
, orbitbucket
. - Deploy
Hooks List<Pulumiverse.Vercel. Inputs. Project Git Repository Deploy Hook> - 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 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
, orbitbucket
. - Deploy
Hooks []ProjectGit Repository Deploy Hook - 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 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
, orbitbucket
. - deploy
Hooks List<ProjectGit Repository Deploy Hook> - 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 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
, orbitbucket
. - deploy
Hooks ProjectGit Repository Deploy Hook[] - 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 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
, orbitbucket
. - deploy_
hooks Sequence[ProjectGit Repository Deploy Hook] - 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
, orbitbucket
. - deploy
Hooks 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.
- production
Branch 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
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.
- Issuer
Mode string - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- 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.
- Issuer
Mode string - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- 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.
- issuer
Mode String - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- 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.
- issuer
Mode string - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- 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.
- issuer_
mode str - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
- 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.
- issuer
Mode String - Configures the URL of the
iss
claim.team
=https://oidc.vercel.com/[team_slug]
global
=https://oidc.vercel.com
ProjectOptionsAllowlist, ProjectOptionsAllowlistArgs
- Paths
List<Pulumiverse.
Vercel. Inputs. Project Options Allowlist Path> - 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
[]Project
Options Allowlist Path - 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<Project
Options Allowlist Path> - 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
Project
Options Allowlist Path[] - 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[Project
Options Allowlist Path] - 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
- Deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
, oronly_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 string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
, oronly_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 String - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
, oronly_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 string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
, oronly_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
, oronly_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.
- deployment
Type String - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
, oronly_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
- Fluid bool
- Enable fluid compute for your Vercel Functions to automatically manage concurrency and optimize performance. Vercel will handle the defaults to ensure the best experience for your workload.
- Function
Default stringCpu Type - 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 intTimeout - The default timeout for Serverless Functions.
- Fluid bool
- Enable fluid compute for your Vercel Functions to automatically manage concurrency and optimize performance. Vercel will handle the defaults to ensure the best experience for your workload.
- Function
Default stringCpu Type - 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 intTimeout - The default timeout for Serverless Functions.
- fluid Boolean
- Enable fluid compute for your Vercel Functions to automatically manage concurrency and optimize performance. Vercel will handle the defaults to ensure the best experience for your workload.
- function
Default StringCpu Type - 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 IntegerTimeout - The default timeout for Serverless Functions.
- fluid boolean
- Enable fluid compute for your Vercel Functions to automatically manage concurrency and optimize performance. Vercel will handle the defaults to ensure the best experience for your workload.
- function
Default stringCpu Type - 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 numberTimeout - The default timeout for Serverless Functions.
- fluid bool
- Enable fluid compute for your Vercel Functions to automatically manage concurrency and optimize performance. Vercel will handle the defaults to ensure the best experience for your workload.
- function_
default_ strcpu_ type - 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_ inttimeout - The default timeout for Serverless Functions.
- fluid Boolean
- Enable fluid compute for your Vercel Functions to automatically manage concurrency and optimize performance. Vercel will handle the defaults to ensure the best experience for your workload.
- function
Default StringCpu Type - 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 NumberTimeout - The default timeout for Serverless Functions.
ProjectTrustedIps, ProjectTrustedIpsArgs
- Addresses
List<Pulumiverse.
Vercel. Inputs. Project Trusted Ips Address> - The allowed IP addressses and CIDR ranges with optional descriptions.
- Deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_production_deployments
, oronly_preview_deployments
. - Protection
Mode string - Whether or not Trusted IPs is optional to access a deployment. Must be either
trusted_ip_required
ortrusted_ip_optional
.trusted_ip_optional
is only available with Standalone Trusted IPs.
- Addresses
[]Project
Trusted Ips Address - The allowed IP addressses and CIDR ranges with optional descriptions.
- Deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_production_deployments
, oronly_preview_deployments
. - Protection
Mode string - Whether or not Trusted IPs is optional to access a deployment. Must be either
trusted_ip_required
ortrusted_ip_optional
.trusted_ip_optional
is only available with Standalone Trusted IPs.
- addresses
List<Project
Trusted Ips Address> - The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment
Type String - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_production_deployments
, oronly_preview_deployments
. - protection
Mode String - Whether or not Trusted IPs is optional to access a deployment. Must be either
trusted_ip_required
ortrusted_ip_optional
.trusted_ip_optional
is only available with Standalone Trusted IPs.
- addresses
Project
Trusted Ips Address[] - The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_production_deployments
, oronly_preview_deployments
. - protection
Mode string - Whether or not Trusted IPs is optional to access a deployment. Must be either
trusted_ip_required
ortrusted_ip_optional
.trusted_ip_optional
is only available with Standalone Trusted IPs.
- addresses
Sequence[Project
Trusted Ips Address] - 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
, oronly_preview_deployments
. - protection_
mode str - Whether or not Trusted IPs is optional to access a deployment. Must be either
trusted_ip_required
ortrusted_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.
- deployment
Type String - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_production_deployments
, oronly_preview_deployments
. - protection
Mode String - Whether or not Trusted IPs is optional to access a deployment. Must be either
trusted_ip_required
ortrusted_ip_optional
.trusted_ip_optional
is only available with Standalone Trusted IPs.
ProjectTrustedIpsAddress, ProjectTrustedIpsAddressArgs
ProjectVercelAuthentication, ProjectVercelAuthenticationArgs
- Deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_preview_deployments
, ornone
.
- Deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_preview_deployments
, ornone
.
- deployment
Type String - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_preview_deployments
, ornone
.
- deployment
Type string - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_preview_deployments
, ornone
.
- deployment_
type str - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_preview_deployments
, ornone
.
- deployment
Type String - The deployment environment to protect. Must be one of
standard_protection
,all_deployments
,only_preview_deployments
, ornone
.
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.