published on Wednesday, Jul 22, 2026 by Pulumiverse
published on Wednesday, Jul 22, 2026 by Pulumiverse
Provides a Project resource.
A Project groups deployments and custom domains. To deploy on Vercel, you need to create a Project.
For more detailed information, please see the Vercel documentation.
Terraform currently provides a standalone Project Environment Variable resource (a single Environment Variable), a Project Environment Variables resource (multiple Environment Variables), and this Project resource with Environment Variables defined in-line via the
environmentfield. At this time you cannot use a Vercel Project resource with in-lineenvironmentin conjunction with anyvercel.ProjectEnvironmentVariablesorvercel.ProjectEnvironmentVariableresources. Doing so will cause a conflict of settings and will overwrite Environment Variables.
Note: Starting in provider version
4.8.0, in-line Project Environment Variables require an explicitsensitivevalue. Variables targeting onlydevelopmentmust setsensitive = false. If your team enforces sensitive environment variables, variables targetingpreview,production, or custom environments must setsensitive = true. When that team policy is enabled, a variable cannot targetdevelopmenttogether withpreview,production, or custom environments.
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",
protectedSourcemaps: true,
});
const githubActionsTrustedSource = {
issuer: "https://token.actions.githubusercontent.com",
label: "GitHub Actions",
to: {
slugs: ["preview"],
},
claims: {
aud: ["example-audience"],
sub: ["repo:vercel/some-repo:ref:refs/heads/main"],
},
};
// A project that allows trusted sources to bypass Deployment Protection.
const withTrustedSources = new vercel.Project("with_trusted_sources", {
name: "example-project-with-trusted-sources",
framework: "nextjs",
trustedSources: {
projects: [{
projectId: withGit.id,
label: "Source project",
customAllow: [{
from: {
slugs: ["production"],
},
to: {
slugs: [
"preview",
"production",
],
},
}],
}],
externalSources: [githubActionsTrustedSource],
},
});
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",
protected_sourcemaps=True)
github_actions_trusted_source = {
"issuer": "https://token.actions.githubusercontent.com",
"label": "GitHub Actions",
"to": {
"slugs": ["preview"],
},
"claims": {
"aud": ["example-audience"],
"sub": ["repo:vercel/some-repo:ref:refs/heads/main"],
},
}
# A project that allows trusted sources to bypass Deployment Protection.
with_trusted_sources = vercel.Project("with_trusted_sources",
name="example-project-with-trusted-sources",
framework="nextjs",
trusted_sources={
"projects": [{
"project_id": with_git.id,
"label": "Source project",
"custom_allow": [{
"from": {
"slugs": ["production"],
},
"to": {
"slugs": [
"preview",
"production",
],
},
}],
}],
"external_sources": [github_actions_trusted_source],
})
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-vercel/sdk/v5/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.
withGit, 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"),
ProtectedSourcemaps: pulumi.Bool(true),
})
if err != nil {
return err
}
githubActionsTrustedSource := map[string]interface{}{
"issuer": "https://token.actions.githubusercontent.com",
"label": "GitHub Actions",
"to": map[string]interface{}{
"slugs": []string{
"preview",
},
},
"claims": map[string]interface{}{
"aud": []string{
"example-audience",
},
"sub": []string{
"repo:vercel/some-repo:ref:refs/heads/main",
},
},
}
// A project that allows trusted sources to bypass Deployment Protection.
_, err = vercel.NewProject(ctx, "with_trusted_sources", &vercel.ProjectArgs{
Name: pulumi.String("example-project-with-trusted-sources"),
Framework: pulumi.String("nextjs"),
TrustedSources: &vercel.ProjectTrustedSourcesArgs{
Projects: vercel.ProjectTrustedSourcesProjectArray{
&vercel.ProjectTrustedSourcesProjectArgs{
ProjectId: withGit.ID(),
Label: pulumi.String("Source project"),
CustomAllow: []map[string]interface{}{
map[string]interface{}{
"from": map[string]interface{}{
"slugs": []string{
"production",
},
},
"to": map[string]interface{}{
"slugs": []string{
"preview",
"production",
},
},
},
},
},
},
ExternalSources: vercel.ProjectTrustedSourcesExternalSourceArray{
pulumi.Map(githubActionsTrustedSource),
},
},
})
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",
ProtectedSourcemaps = true,
});
var githubActionsTrustedSource =
{
{ "issuer", "https://token.actions.githubusercontent.com" },
{ "label", "GitHub Actions" },
{ "to",
{
{ "slugs", new[]
{
"preview",
} },
} },
{ "claims",
{
{ "aud", new[]
{
"example-audience",
} },
{ "sub", new[]
{
"repo:vercel/some-repo:ref:refs/heads/main",
} },
} },
};
// A project that allows trusted sources to bypass Deployment Protection.
var withTrustedSources = new Vercel.Project("with_trusted_sources", new()
{
Name = "example-project-with-trusted-sources",
Framework = "nextjs",
TrustedSources = new Vercel.Inputs.ProjectTrustedSourcesArgs
{
Projects = new[]
{
new Vercel.Inputs.ProjectTrustedSourcesProjectArgs
{
ProjectId = withGit.Id,
Label = "Source project",
CustomAllow = new[]
{
{
{ "from",
{
{ "slugs", new[]
{
"production",
} },
} },
{ "to",
{
{ "slugs", new[]
{
"preview",
"production",
} },
} },
},
},
},
},
ExternalSources = new[]
{
githubActionsTrustedSource,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumiverse.vercel.Project;
import com.pulumiverse.vercel.ProjectArgs;
import com.pulumi.vercel.inputs.ProjectGitRepositoryArgs;
import com.pulumi.vercel.inputs.ProjectTrustedSourcesArgs;
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")
.protectedSourcemaps(true)
.build());
final var githubActionsTrustedSource = Map.ofEntries(
Map.entry("issuer", "https://token.actions.githubusercontent.com"),
Map.entry("label", "GitHub Actions"),
Map.entry("to", Map.of("slugs", "preview")),
Map.entry("claims", Map.ofEntries(
Map.entry("aud", "example-audience"),
Map.entry("sub", "repo:vercel/some-repo:ref:refs/heads/main")
))
);
// A project that allows trusted sources to bypass Deployment Protection.
var withTrustedSources = new Project("withTrustedSources", ProjectArgs.builder()
.name("example-project-with-trusted-sources")
.framework("nextjs")
.trustedSources(ProjectTrustedSourcesArgs.builder()
.projects(ProjectTrustedSourcesProjectArgs.builder()
.projectId(withGit.id())
.label("Source project")
.customAllow(List.of(Map.ofEntries(
Map.entry("from", Map.of("slugs", List.of("production"))),
Map.entry("to", Map.of("slugs", List.of(
"preview",
"production")))
)))
.build())
.externalSources(githubActionsTrustedSource)
.build())
.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
protectedSourcemaps: true
# A project that allows trusted sources to bypass Deployment Protection.
withTrustedSources:
type: vercel:Project
name: with_trusted_sources
properties:
name: example-project-with-trusted-sources
framework: nextjs
trustedSources:
projects:
- projectId: ${withGit.id}
label: Source project
customAllow:
- from:
slugs:
- production
to:
slugs:
- preview
- production
externalSources:
- ${githubActionsTrustedSource}
variables:
githubActionsTrustedSource:
issuer: https://token.actions.githubusercontent.com
label: GitHub Actions
to:
slugs:
- preview
claims:
aud:
- example-audience
sub:
- repo:vercel/some-repo:ref:refs/heads/main
Example coming soon!
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,
build_machine_type: 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_provider_options: Optional[ProjectGitProviderOptionsArgs] = 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,
preview_deployment_suffix: Optional[str] = None,
preview_deployments_disabled: Optional[bool] = None,
prioritise_production_builds: Optional[bool] = None,
protected_sourcemaps: Optional[bool] = None,
public_source: Optional[bool] = None,
resource_config: Optional[ProjectResourceConfigArgs] = None,
root_directory: Optional[str] = None,
serverless_function_region: Optional[str] = None,
skew_protection: Optional[str] = None,
team_id: Optional[str] = None,
trusted_ips: Optional[ProjectTrustedIpsArgs] = None,
trusted_sources: Optional[ProjectTrustedSourcesArgs] = 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.
resource "vercel_project" "name" {
# resource properties
}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",
BuildMachineType = "string",
CustomerSuccessCodeVisibility = false,
DevCommand = "string",
DirectoryListing = false,
EnableAffectedProjectsDeployments = false,
EnablePreviewFeedback = false,
EnableProductionFeedback = false,
Environments = new[]
{
new Vercel.Inputs.ProjectEnvironmentArgs
{
Key = "string",
Sensitive = false,
Value = "string",
Comment = "string",
CustomEnvironmentIds = new[]
{
"string",
},
GitBranch = "string",
Id = "string",
Targets = new[]
{
"string",
},
},
},
Framework = "string",
FunctionFailover = false,
GitComments = new Vercel.Inputs.ProjectGitCommentsArgs
{
OnCommit = false,
OnPullRequest = false,
},
GitForkProtection = false,
GitLfs = false,
GitProviderOptions = new Vercel.Inputs.ProjectGitProviderOptionsArgs
{
ConsolidatedGitCommitStatus = new Vercel.Inputs.ProjectGitProviderOptionsConsolidatedGitCommitStatusArgs
{
Enabled = false,
PropagateFailures = false,
},
CreateDeployments = false,
GitCommitStatus = false,
RepositoryDispatchEvents = false,
RequireVerifiedCommits = 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
{
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",
},
PreviewDeploymentSuffix = "string",
PreviewDeploymentsDisabled = false,
PrioritiseProductionBuilds = false,
ProtectedSourcemaps = false,
ResourceConfig = new Vercel.Inputs.ProjectResourceConfigArgs
{
Fluid = false,
FunctionDefaultCpuType = "string",
FunctionDefaultRegions = new[]
{
"string",
},
FunctionDefaultTimeout = 0,
},
RootDirectory = "string",
SkewProtection = "string",
TeamId = "string",
TrustedIps = new Vercel.Inputs.ProjectTrustedIpsArgs
{
Addresses = new[]
{
new Vercel.Inputs.ProjectTrustedIpsAddressArgs
{
Value = "string",
Note = "string",
},
},
DeploymentType = "string",
ProtectionMode = "string",
},
TrustedSources = new Vercel.Inputs.ProjectTrustedSourcesArgs
{
ExternalSources = new[]
{
new Vercel.Inputs.ProjectTrustedSourcesExternalSourceArgs
{
Claims =
{
{ "string", new[]
{
"string",
} },
},
Issuer = "string",
To = new Vercel.Inputs.ProjectTrustedSourcesExternalSourceToArgs
{
Preset = "string",
Slugs = new[]
{
"string",
},
},
Label = "string",
},
},
Projects = new[]
{
new Vercel.Inputs.ProjectTrustedSourcesProjectArgs
{
ProjectId = "string",
CustomAllows = new[]
{
new Vercel.Inputs.ProjectTrustedSourcesProjectCustomAllowArgs
{
From = new Vercel.Inputs.ProjectTrustedSourcesProjectCustomAllowFromArgs
{
Preset = "string",
Slugs = new[]
{
"string",
},
},
To = new Vercel.Inputs.ProjectTrustedSourcesProjectCustomAllowToArgs
{
Preset = "string",
Slugs = new[]
{
"string",
},
},
},
},
Label = "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"),
BuildMachineType: 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"),
Sensitive: pulumi.Bool(false),
Value: pulumi.String("string"),
Comment: pulumi.String("string"),
CustomEnvironmentIds: pulumi.StringArray{
pulumi.String("string"),
},
GitBranch: pulumi.String("string"),
Id: pulumi.String("string"),
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),
GitProviderOptions: &vercel.ProjectGitProviderOptionsArgs{
ConsolidatedGitCommitStatus: &vercel.ProjectGitProviderOptionsConsolidatedGitCommitStatusArgs{
Enabled: pulumi.Bool(false),
PropagateFailures: pulumi.Bool(false),
},
CreateDeployments: pulumi.Bool(false),
GitCommitStatus: pulumi.Bool(false),
RepositoryDispatchEvents: pulumi.Bool(false),
RequireVerifiedCommits: 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{
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"),
},
PreviewDeploymentSuffix: pulumi.String("string"),
PreviewDeploymentsDisabled: pulumi.Bool(false),
PrioritiseProductionBuilds: pulumi.Bool(false),
ProtectedSourcemaps: pulumi.Bool(false),
ResourceConfig: &vercel.ProjectResourceConfigArgs{
Fluid: pulumi.Bool(false),
FunctionDefaultCpuType: pulumi.String("string"),
FunctionDefaultRegions: pulumi.StringArray{
pulumi.String("string"),
},
FunctionDefaultTimeout: pulumi.Int(0),
},
RootDirectory: 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"),
},
TrustedSources: &vercel.ProjectTrustedSourcesArgs{
ExternalSources: vercel.ProjectTrustedSourcesExternalSourceArray{
&vercel.ProjectTrustedSourcesExternalSourceArgs{
Claims: pulumi.StringArrayMap{
"string": pulumi.StringArray{
pulumi.String("string"),
},
},
Issuer: pulumi.String("string"),
To: &vercel.ProjectTrustedSourcesExternalSourceToArgs{
Preset: pulumi.String("string"),
Slugs: pulumi.StringArray{
pulumi.String("string"),
},
},
Label: pulumi.String("string"),
},
},
Projects: vercel.ProjectTrustedSourcesProjectArray{
&vercel.ProjectTrustedSourcesProjectArgs{
ProjectId: pulumi.String("string"),
CustomAllows: vercel.ProjectTrustedSourcesProjectCustomAllowArray{
&vercel.ProjectTrustedSourcesProjectCustomAllowArgs{
From: &vercel.ProjectTrustedSourcesProjectCustomAllowFromArgs{
Preset: pulumi.String("string"),
Slugs: pulumi.StringArray{
pulumi.String("string"),
},
},
To: &vercel.ProjectTrustedSourcesProjectCustomAllowToArgs{
Preset: pulumi.String("string"),
Slugs: pulumi.StringArray{
pulumi.String("string"),
},
},
},
},
Label: pulumi.String("string"),
},
},
},
VercelAuthentication: &vercel.ProjectVercelAuthenticationArgs{
DeploymentType: pulumi.String("string"),
},
})
resource "vercel_project" "projectResource" {
lifecycle {
create_before_destroy = true
}
auto_assign_custom_domains = false
automatically_expose_system_environment_variables = false
build_command = "string"
build_machine_type = "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"
sensitive = false
value = "string"
comment = "string"
custom_environment_ids = ["string"]
git_branch = "string"
id = "string"
targets = ["string"]
}
framework = "string"
function_failover = false
git_comments = {
on_commit = false
on_pull_request = false
}
git_fork_protection = false
git_lfs = false
git_provider_options = {
consolidated_git_commit_status = {
enabled = false
propagate_failures = false
}
create_deployments = false
git_commit_status = false
repository_dispatch_events = false
require_verified_commits = 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 = {
issuer_mode = "string"
}
on_demand_concurrent_builds = false
options_allowlist = {
paths = [{
value = "string"
}]
}
output_directory = "string"
password_protection = {
deployment_type = "string"
password = "string"
}
preview_deployment_suffix = "string"
preview_deployments_disabled = false
prioritise_production_builds = false
protected_sourcemaps = false
resource_config = {
fluid = false
function_default_cpu_type = "string"
function_default_regions = ["string"]
function_default_timeout = 0
}
root_directory = "string"
skew_protection = "string"
team_id = "string"
trusted_ips = {
addresses = [{
value = "string"
note = "string"
}]
deployment_type = "string"
protection_mode = "string"
}
trusted_sources = {
external_sources = [{
claims = {
"string" = ["string"]
}
issuer = "string"
to = {
preset = "string"
slugs = ["string"]
}
label = "string"
}]
projects = [{
project_id = "string"
custom_allows = [{
from = {
preset = "string"
slugs = ["string"]
}
to = {
preset = "string"
slugs = ["string"]
}
}]
label = "string"
}]
}
vercel_authentication = {
deployment_type = "string"
}
}
var projectResource = new Project("projectResource", ProjectArgs.builder()
.autoAssignCustomDomains(false)
.automaticallyExposeSystemEnvironmentVariables(false)
.buildCommand("string")
.buildMachineType("string")
.customerSuccessCodeVisibility(false)
.devCommand("string")
.directoryListing(false)
.enableAffectedProjectsDeployments(false)
.enablePreviewFeedback(false)
.enableProductionFeedback(false)
.environments(ProjectEnvironmentArgs.builder()
.key("string")
.sensitive(false)
.value("string")
.comment("string")
.customEnvironmentIds("string")
.gitBranch("string")
.id("string")
.targets("string")
.build())
.framework("string")
.functionFailover(false)
.gitComments(ProjectGitCommentsArgs.builder()
.onCommit(false)
.onPullRequest(false)
.build())
.gitForkProtection(false)
.gitLfs(false)
.gitProviderOptions(ProjectGitProviderOptionsArgs.builder()
.consolidatedGitCommitStatus(ProjectGitProviderOptionsConsolidatedGitCommitStatusArgs.builder()
.enabled(false)
.propagateFailures(false)
.build())
.createDeployments(false)
.gitCommitStatus(false)
.repositoryDispatchEvents(false)
.requireVerifiedCommits(false)
.build())
.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()
.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())
.previewDeploymentSuffix("string")
.previewDeploymentsDisabled(false)
.prioritiseProductionBuilds(false)
.protectedSourcemaps(false)
.resourceConfig(ProjectResourceConfigArgs.builder()
.fluid(false)
.functionDefaultCpuType("string")
.functionDefaultRegions("string")
.functionDefaultTimeout(0)
.build())
.rootDirectory("string")
.skewProtection("string")
.teamId("string")
.trustedIps(ProjectTrustedIpsArgs.builder()
.addresses(ProjectTrustedIpsAddressArgs.builder()
.value("string")
.note("string")
.build())
.deploymentType("string")
.protectionMode("string")
.build())
.trustedSources(ProjectTrustedSourcesArgs.builder()
.externalSources(ProjectTrustedSourcesExternalSourceArgs.builder()
.claims(Map.of("string", Arrays.asList("string")))
.issuer("string")
.to(ProjectTrustedSourcesExternalSourceToArgs.builder()
.preset("string")
.slugs("string")
.build())
.label("string")
.build())
.projects(ProjectTrustedSourcesProjectArgs.builder()
.projectId("string")
.customAllows(ProjectTrustedSourcesProjectCustomAllowArgs.builder()
.from(ProjectTrustedSourcesProjectCustomAllowFromArgs.builder()
.preset("string")
.slugs("string")
.build())
.to(ProjectTrustedSourcesProjectCustomAllowToArgs.builder()
.preset("string")
.slugs("string")
.build())
.build())
.label("string")
.build())
.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",
build_machine_type="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",
"sensitive": False,
"value": "string",
"comment": "string",
"custom_environment_ids": ["string"],
"git_branch": "string",
"id": "string",
"targets": ["string"],
}],
framework="string",
function_failover=False,
git_comments={
"on_commit": False,
"on_pull_request": False,
},
git_fork_protection=False,
git_lfs=False,
git_provider_options={
"consolidated_git_commit_status": {
"enabled": False,
"propagate_failures": False,
},
"create_deployments": False,
"git_commit_status": False,
"repository_dispatch_events": False,
"require_verified_commits": 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={
"issuer_mode": "string",
},
on_demand_concurrent_builds=False,
options_allowlist={
"paths": [{
"value": "string",
}],
},
output_directory="string",
password_protection={
"deployment_type": "string",
"password": "string",
},
preview_deployment_suffix="string",
preview_deployments_disabled=False,
prioritise_production_builds=False,
protected_sourcemaps=False,
resource_config={
"fluid": False,
"function_default_cpu_type": "string",
"function_default_regions": ["string"],
"function_default_timeout": 0,
},
root_directory="string",
skew_protection="string",
team_id="string",
trusted_ips={
"addresses": [{
"value": "string",
"note": "string",
}],
"deployment_type": "string",
"protection_mode": "string",
},
trusted_sources={
"external_sources": [{
"claims": {
"string": ["string"],
},
"issuer": "string",
"to": {
"preset": "string",
"slugs": ["string"],
},
"label": "string",
}],
"projects": [{
"project_id": "string",
"custom_allows": [{
"from_": {
"preset": "string",
"slugs": ["string"],
},
"to": {
"preset": "string",
"slugs": ["string"],
},
}],
"label": "string",
}],
},
vercel_authentication={
"deployment_type": "string",
})
const projectResource = new vercel.Project("projectResource", {
autoAssignCustomDomains: false,
automaticallyExposeSystemEnvironmentVariables: false,
buildCommand: "string",
buildMachineType: "string",
customerSuccessCodeVisibility: false,
devCommand: "string",
directoryListing: false,
enableAffectedProjectsDeployments: false,
enablePreviewFeedback: false,
enableProductionFeedback: false,
environments: [{
key: "string",
sensitive: false,
value: "string",
comment: "string",
customEnvironmentIds: ["string"],
gitBranch: "string",
id: "string",
targets: ["string"],
}],
framework: "string",
functionFailover: false,
gitComments: {
onCommit: false,
onPullRequest: false,
},
gitForkProtection: false,
gitLfs: false,
gitProviderOptions: {
consolidatedGitCommitStatus: {
enabled: false,
propagateFailures: false,
},
createDeployments: false,
gitCommitStatus: false,
repositoryDispatchEvents: false,
requireVerifiedCommits: 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: {
issuerMode: "string",
},
onDemandConcurrentBuilds: false,
optionsAllowlist: {
paths: [{
value: "string",
}],
},
outputDirectory: "string",
passwordProtection: {
deploymentType: "string",
password: "string",
},
previewDeploymentSuffix: "string",
previewDeploymentsDisabled: false,
prioritiseProductionBuilds: false,
protectedSourcemaps: false,
resourceConfig: {
fluid: false,
functionDefaultCpuType: "string",
functionDefaultRegions: ["string"],
functionDefaultTimeout: 0,
},
rootDirectory: "string",
skewProtection: "string",
teamId: "string",
trustedIps: {
addresses: [{
value: "string",
note: "string",
}],
deploymentType: "string",
protectionMode: "string",
},
trustedSources: {
externalSources: [{
claims: {
string: ["string"],
},
issuer: "string",
to: {
preset: "string",
slugs: ["string"],
},
label: "string",
}],
projects: [{
projectId: "string",
customAllows: [{
from: {
preset: "string",
slugs: ["string"],
},
to: {
preset: "string",
slugs: ["string"],
},
}],
label: "string",
}],
},
vercelAuthentication: {
deploymentType: "string",
},
});
type: vercel:Project
properties:
autoAssignCustomDomains: false
automaticallyExposeSystemEnvironmentVariables: false
buildCommand: string
buildMachineType: 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
gitProviderOptions:
consolidatedGitCommitStatus:
enabled: false
propagateFailures: false
createDeployments: false
gitCommitStatus: false
repositoryDispatchEvents: false
requireVerifiedCommits: 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:
issuerMode: string
onDemandConcurrentBuilds: false
optionsAllowlist:
paths:
- value: string
outputDirectory: string
passwordProtection:
deploymentType: string
password: string
previewDeploymentSuffix: string
previewDeploymentsDisabled: false
prioritiseProductionBuilds: false
protectedSourcemaps: false
resourceConfig:
fluid: false
functionDefaultCpuType: string
functionDefaultRegions:
- string
functionDefaultTimeout: 0
rootDirectory: string
skewProtection: string
teamId: string
trustedIps:
addresses:
- note: string
value: string
deploymentType: string
protectionMode: string
trustedSources:
externalSources:
- claims:
string:
- string
issuer: string
label: string
to:
preset: string
slugs:
- string
projects:
- customAllows:
- from:
preset: string
slugs:
- string
to:
preset: string
slugs:
- string
label: string
projectId: 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.
- Build
Machine stringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider Pulumiverse.Options Vercel. Inputs. Project Git Provider Options - Git provider options
- 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
OPTIONSrequests 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.
- Preview
Deployment stringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- Preview
Deployments boolDisabled - Disable creation of Preview Deployments for this project.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protected
Sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- Public
Source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- Trusted
Sources Pulumiverse.Vercel. Inputs. Project Trusted Sources - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- Build
Machine stringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider ProjectOptions Git Provider Options Args - Git provider options
- 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
OPTIONSrequests 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.
- Preview
Deployment stringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- Preview
Deployments boolDisabled - Disable creation of Preview Deployments for this project.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protected
Sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- Public
Source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- Trusted
Sources ProjectTrusted Sources Args - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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_ 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.
- build_
machine_ stringtype - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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(object)
- 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 object - 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_
provider_ objectoptions - Git provider options
- git_
repository object - 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_ objectconfig - 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 object - Disable Deployment Protection for CORS preflight
OPTIONSrequests for a list of paths. - output_
directory string - The output directory of the project. If omitted, this value will be automatically detected.
- password_
protection object - 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.
- preview_
deployment_ stringsuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview_
deployments_ booldisabled - Disable creation of Preview Deployments for this project.
- prioritise_
production_ boolbuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected_
sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- public_
source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- resource_
config object - 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 object - Ensures only visitors from an allowed IP address can access your deployment.
- trusted_
sources object - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- vercel_
authentication object - 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.
- build
Machine StringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider ProjectOptions Git Provider Options - Git provider options
- 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
OPTIONSrequests 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.
- preview
Deployment StringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview
Deployments BooleanDisabled - Disable creation of Preview Deployments for this project.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected
Sourcemaps Boolean - Specifies whether sourcemaps are protected and require authentication to access.
- public
Source Boolean - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted
Sources ProjectTrusted Sources - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- build
Machine stringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider ProjectOptions Git Provider Options - Git provider options
- 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
OPTIONSrequests 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.
- preview
Deployment stringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview
Deployments booleanDisabled - Disable creation of Preview Deployments for this project.
- prioritise
Production booleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected
Sourcemaps boolean - Specifies whether sourcemaps are protected and require authentication to access.
- public
Source boolean - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted
Sources ProjectTrusted Sources - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- build_
machine_ strtype - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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_
provider_ Projectoptions Git Provider Options Args - Git provider options
- 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
OPTIONSrequests 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.
- preview_
deployment_ strsuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview_
deployments_ booldisabled - Disable creation of Preview Deployments for this project.
- prioritise_
production_ boolbuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected_
sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- public_
source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted_
sources ProjectTrusted Sources Args - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- build
Machine StringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider Property MapOptions - Git provider options
- 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
OPTIONSrequests 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.
- preview
Deployment StringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview
Deployments BooleanDisabled - Disable creation of Preview Deployments for this project.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected
Sourcemaps Boolean - Specifies whether sourcemaps are protected and require authentication to access.
- public
Source Boolean - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted
Sources Property Map - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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 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,
build_machine_type: 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_provider_options: Optional[ProjectGitProviderOptionsArgs] = 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,
preview_deployment_suffix: Optional[str] = None,
preview_deployments_disabled: Optional[bool] = None,
prioritise_production_builds: Optional[bool] = None,
protected_sourcemaps: Optional[bool] = None,
public_source: Optional[bool] = None,
resource_config: Optional[ProjectResourceConfigArgs] = None,
root_directory: Optional[str] = None,
serverless_function_region: Optional[str] = None,
skew_protection: Optional[str] = None,
team_id: Optional[str] = None,
trusted_ips: Optional[ProjectTrustedIpsArgs] = None,
trusted_sources: Optional[ProjectTrustedSourcesArgs] = None,
vercel_authentication: Optional[ProjectVercelAuthenticationArgs] = None) -> Projectfunc 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}import {
to = vercel_project.example
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.
- Build
Machine stringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider Pulumiverse.Options Vercel. Inputs. Project Git Provider Options - Git provider options
- 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
OPTIONSrequests 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.
- Preview
Deployment stringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- Preview
Deployments boolDisabled - Disable creation of Preview Deployments for this project.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protected
Sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- Public
Source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- Trusted
Sources Pulumiverse.Vercel. Inputs. Project Trusted Sources - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- Build
Machine stringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider ProjectOptions Git Provider Options Args - Git provider options
- 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
OPTIONSrequests 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.
- Preview
Deployment stringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- Preview
Deployments boolDisabled - Disable creation of Preview Deployments for this project.
- Prioritise
Production boolBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- Protected
Sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- Public
Source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- Trusted
Sources ProjectTrusted Sources Args - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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_ 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.
- build_
machine_ stringtype - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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(object)
- 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 object - 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_
provider_ objectoptions - Git provider options
- git_
repository object - 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_ objectconfig - 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 object - Disable Deployment Protection for CORS preflight
OPTIONSrequests for a list of paths. - output_
directory string - The output directory of the project. If omitted, this value will be automatically detected.
- password_
protection object - 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.
- preview_
deployment_ stringsuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview_
deployments_ booldisabled - Disable creation of Preview Deployments for this project.
- prioritise_
production_ boolbuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected_
sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- public_
source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- resource_
config object - 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 object - Ensures only visitors from an allowed IP address can access your deployment.
- trusted_
sources object - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- vercel_
authentication object - 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.
- build
Machine StringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider ProjectOptions Git Provider Options - Git provider options
- 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
OPTIONSrequests 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.
- preview
Deployment StringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview
Deployments BooleanDisabled - Disable creation of Preview Deployments for this project.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected
Sourcemaps Boolean - Specifies whether sourcemaps are protected and require authentication to access.
- public
Source Boolean - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted
Sources ProjectTrusted Sources - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- build
Machine stringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider ProjectOptions Git Provider Options - Git provider options
- 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
OPTIONSrequests 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.
- preview
Deployment stringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview
Deployments booleanDisabled - Disable creation of Preview Deployments for this project.
- prioritise
Production booleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected
Sourcemaps boolean - Specifies whether sourcemaps are protected and require authentication to access.
- public
Source boolean - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted
Sources ProjectTrusted Sources - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- build_
machine_ strtype - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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_
provider_ Projectoptions Git Provider Options Args - Git provider options
- 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
OPTIONSrequests 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.
- preview_
deployment_ strsuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview_
deployments_ booldisabled - Disable creation of Preview Deployments for this project.
- prioritise_
production_ boolbuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected_
sourcemaps bool - Specifies whether sourcemaps are protected and require authentication to access.
- public_
source bool - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted_
sources ProjectTrusted Sources Args - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- build
Machine StringType - The build machine type to use for this project. Must be one of "standard", "enhanced", "turbo", or "elastic". When set to "elastic", Vercel automatically adjusts the underlying machine type based on build duration.
- 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
Provider Property MapOptions - Git provider options
- 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
OPTIONSrequests 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.
- preview
Deployment StringSuffix - The preview deployment suffix to apply to preview deployment URLs for this project. If not set, Vercel's default suffix will be used.
- preview
Deployments BooleanDisabled - Disable creation of Preview Deployments for this project.
- prioritise
Production BooleanBuilds - If enabled, builds for the Production environment will be prioritized over Preview environments.
- protected
Sourcemaps Boolean - Specifies whether sourcemaps are protected and require authentication to access.
- public
Source Boolean - Deprecated. The public source feature has been removed from Vercel; this attribute no longer has any effect.
- 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.
- trusted
Sources Property Map - Allows configured Vercel projects and external sources to reach this project's protected deployments using short-lived OIDC tokens.
- 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.
- Sensitive bool
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - Git
Branch string - The git branch of the Environment Variable.
- Id string
- The ID of the Environment Variable.
- Targets List<string>
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust be set.
- Key string
- The name of the Environment Variable.
- Sensitive bool
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - Git
Branch string - The git branch of the Environment Variable.
- Id string
- The ID of the Environment Variable.
- Targets []string
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust be set.
- key string
- The name of the Environment Variable.
- sensitive bool
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - git_
branch string - The git branch of the Environment Variable.
- id string
- The ID of the Environment Variable.
- targets list(string)
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust be set.
- key String
- The name of the Environment Variable.
- sensitive Boolean
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - git
Branch String - The git branch of the Environment Variable.
- id String
- The ID of the Environment Variable.
- targets List<String>
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust be set.
- key string
- The name of the Environment Variable.
- sensitive boolean
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - git
Branch string - The git branch of the Environment Variable.
- id string
- The ID of the Environment Variable.
- targets string[]
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust be set.
- key str
- The name of the Environment Variable.
- sensitive bool
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - git_
branch str - The git branch of the Environment Variable.
- id str
- The ID of the Environment Variable.
- targets Sequence[str]
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust be set.
- key String
- The name of the Environment Variable.
- sensitive Boolean
- Whether the Environment Variable is sensitive (meaning it cannot be read via the API or Vercel Dashboard once set). This must be explicitly set. If a team-wide environment variable policy is active, environment variables may have to be sensitive. Variables targeting only
developmentmust set this tofalse. Variables targetingpreview,production, or custom environments may have to set this totrue. A variable cannot targetdevelopmenttogether withpreview,production, or custom environments while that team policy is enabled. - 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
targetorcustom_environment_idsmust be set. - git
Branch String - The git branch of the Environment Variable.
- id String
- The ID of the Environment Variable.
- targets List<String>
- The environments that the Environment Variable should be present on. Valid targets are either
production,preview, ordevelopment. At least one oftargetorcustom_environment_idsmust 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 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
ProjectGitProviderOptions, ProjectGitProviderOptionsArgs
- Consolidated
Git Pulumiverse.Commit Status Vercel. Inputs. Project Git Provider Options Consolidated Git Commit Status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- Create
Deployments bool - Whether to create deployments
- Git
Commit boolStatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - Repository
Dispatch boolEvents - Whether to enable repository dispatch events
- Require
Verified boolCommits - Whether to require verified commits
- Consolidated
Git ProjectCommit Status Git Provider Options Consolidated Git Commit Status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- Create
Deployments bool - Whether to create deployments
- Git
Commit boolStatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - Repository
Dispatch boolEvents - Whether to enable repository dispatch events
- Require
Verified boolCommits - Whether to require verified commits
- consolidated_
git_ objectcommit_ status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- create_
deployments bool - Whether to create deployments
- git_
commit_ boolstatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - repository_
dispatch_ boolevents - Whether to enable repository dispatch events
- require_
verified_ boolcommits - Whether to require verified commits
- consolidated
Git ProjectCommit Status Git Provider Options Consolidated Git Commit Status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- create
Deployments Boolean - Whether to create deployments
- git
Commit BooleanStatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - repository
Dispatch BooleanEvents - Whether to enable repository dispatch events
- require
Verified BooleanCommits - Whether to require verified commits
- consolidated
Git ProjectCommit Status Git Provider Options Consolidated Git Commit Status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- create
Deployments boolean - Whether to create deployments
- git
Commit booleanStatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - repository
Dispatch booleanEvents - Whether to enable repository dispatch events
- require
Verified booleanCommits - Whether to require verified commits
- consolidated_
git_ Projectcommit_ status Git Provider Options Consolidated Git Commit Status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- create_
deployments bool - Whether to create deployments
- git_
commit_ boolstatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - repository_
dispatch_ boolevents - Whether to enable repository dispatch events
- require_
verified_ boolcommits - Whether to require verified commits
- consolidated
Git Property MapCommit Status - Beta: Configuration for consolidated git commit status reporting. When enabled, Vercel posts a single consolidated commit status instead of one per deployment. This feature is in beta and may change in backwards-incompatible ways.
- create
Deployments Boolean - Whether to create deployments
- git
Commit BooleanStatus - Whether Vercel should post git commit statuses for this project. Defaults to
truewhen unset. - repository
Dispatch BooleanEvents - Whether to enable repository dispatch events
- require
Verified BooleanCommits - Whether to require verified commits
ProjectGitProviderOptionsConsolidatedGitCommitStatus, ProjectGitProviderOptionsConsolidatedGitCommitStatusArgs
- Enabled bool
- Beta: Whether consolidated commit status is enabled.
- Propagate
Failures bool - Beta: Whether to propagate individual deployment failures to the consolidated status.
- Enabled bool
- Beta: Whether consolidated commit status is enabled.
- Propagate
Failures bool - Beta: Whether to propagate individual deployment failures to the consolidated status.
- enabled bool
- Beta: Whether consolidated commit status is enabled.
- propagate_
failures bool - Beta: Whether to propagate individual deployment failures to the consolidated status.
- enabled Boolean
- Beta: Whether consolidated commit status is enabled.
- propagate
Failures Boolean - Beta: Whether to propagate individual deployment failures to the consolidated status.
- enabled boolean
- Beta: Whether consolidated commit status is enabled.
- propagate
Failures boolean - Beta: Whether to propagate individual deployment failures to the consolidated status.
- enabled bool
- Beta: Whether consolidated commit status is enabled.
- propagate_
failures bool - Beta: Whether to propagate individual deployment failures to the consolidated status.
- enabled Boolean
- Beta: Whether consolidated commit status is enabled.
- propagate
Failures Boolean - Beta: Whether to propagate individual deployment failures to the consolidated status.
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(object) - 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
- Issuer
Mode string - Configures the URL of the
issclaim.team=https://oidc.vercel.com/[team_slug]global=https://oidc.vercel.com
- Issuer
Mode string - Configures the URL of the
issclaim.team=https://oidc.vercel.com/[team_slug]global=https://oidc.vercel.com
- issuer_
mode string - Configures the URL of the
issclaim.team=https://oidc.vercel.com/[team_slug]global=https://oidc.vercel.com
- issuer
Mode String - Configures the URL of the
issclaim.team=https://oidc.vercel.com/[team_slug]global=https://oidc.vercel.com
- issuer
Mode string - Configures the URL of the
issclaim.team=https://oidc.vercel.com/[team_slug]global=https://oidc.vercel.com
- issuer_
mode str - Configures the URL of the
issclaim.team=https://oidc.vercel.com/[team_slug]global=https://oidc.vercel.com
- issuer
Mode String - Configures the URL of the
issclaim.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
OPTIONSand 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
OPTIONSand start with one of the path values.
- paths list(object)
- The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method
OPTIONSand 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
OPTIONSand 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
OPTIONSand 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
OPTIONSand 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
OPTIONSand 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 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_new(Standard Protection),standard_protection(Legacy 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_new(Standard Protection),standard_protection(Legacy 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_new(Standard Protection),standard_protection(Legacy 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_new(Standard Protection),standard_protection(Legacy 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_new(Standard Protection),standard_protection(Legacy 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_new(Standard Protection),standard_protection(Legacy 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_new(Standard Protection),standard_protection(Legacy 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 List<string>Regions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- 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 []stringRegions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- 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_ list(string)regions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- function_
default_ numbertimeout - 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 List<String>Regions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- 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 string[]Regions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- 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_ Sequence[str]regions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- 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 List<String>Regions - The default regions for Serverless Functions. Must be an array of valid region identifiers.
- 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_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis 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_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis only available with Standalone Trusted IPs.
- addresses list(object)
- The allowed IP addressses and CIDR ranges with optional descriptions.
- deployment_
type string - The deployment environment to protect. Must be one of
standard_protection_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis 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_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis 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_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis 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_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis 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_new(Standard Protection),standard_protection(Legacy 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_requiredortrusted_ip_optional.trusted_ip_optionalis only available with Standalone Trusted IPs.
ProjectTrustedIpsAddress, ProjectTrustedIpsAddressArgs
ProjectTrustedSources, ProjectTrustedSourcesArgs
- External
Sources List<Pulumiverse.Vercel. Inputs. Project Trusted Sources External Source> - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- Projects
List<Pulumiverse.
Vercel. Inputs. Project Trusted Sources Project> - Vercel projects in the same team that can reach this project's protected deployments.
- External
Sources []ProjectTrusted Sources External Source - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- Projects
[]Project
Trusted Sources Project - Vercel projects in the same team that can reach this project's protected deployments.
- external_
sources list(object) - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- projects list(object)
- Vercel projects in the same team that can reach this project's protected deployments.
- external
Sources List<ProjectTrusted Sources External Source> - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- projects
List<Project
Trusted Sources Project> - Vercel projects in the same team that can reach this project's protected deployments.
- external
Sources ProjectTrusted Sources External Source[] - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- projects
Project
Trusted Sources Project[] - Vercel projects in the same team that can reach this project's protected deployments.
- external_
sources Sequence[ProjectTrusted Sources External Source] - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- projects
Sequence[Project
Trusted Sources Project] - Vercel projects in the same team that can reach this project's protected deployments.
- external
Sources List<Property Map> - External sources that can reach this project's protected deployments using short-lived OIDC tokens.
- projects List<Property Map>
- Vercel projects in the same team that can reach this project's protected deployments.
ProjectTrustedSourcesExternalSource, ProjectTrustedSourcesExternalSourceArgs
- Claims
Dictionary<string, Immutable
Array<string>> - Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - Issuer string
- The OIDC issuer URL.
- To
Pulumiverse.
Vercel. Inputs. Project Trusted Sources External Source To - The target environments on this project that may be accessed.
- Label string
- A label or description for the trusted external source entry.
- Claims map[string][]string
- Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - Issuer string
- The OIDC issuer URL.
- To
Project
Trusted Sources External Source To - The target environments on this project that may be accessed.
- Label string
- A label or description for the trusted external source entry.
- claims map(list(string))
- Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - issuer string
- The OIDC issuer URL.
- to object
- The target environments on this project that may be accessed.
- label string
- A label or description for the trusted external source entry.
- claims Map<String,List<String>>
- Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - issuer String
- The OIDC issuer URL.
- to
Project
Trusted Sources External Source To - The target environments on this project that may be accessed.
- label String
- A label or description for the trusted external source entry.
- claims {[key: string]: string[]}
- Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - issuer string
- The OIDC issuer URL.
- to
Project
Trusted Sources External Source To - The target environments on this project that may be accessed.
- label string
- A label or description for the trusted external source entry.
- claims Mapping[str, Sequence[str]]
- Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - issuer str
- The OIDC issuer URL.
- to
Project
Trusted Sources External Source To - The target environments on this project that may be accessed.
- label str
- A label or description for the trusted external source entry.
- claims Map<List<String>>
- Claims that must match on the OIDC token. Each key is a claim name, and each value is a set of accepted values. The API requires
audand issuer-specific identity claims. - issuer String
- The OIDC issuer URL.
- to Property Map
- The target environments on this project that may be accessed.
- label String
- A label or description for the trusted external source entry.
ProjectTrustedSourcesExternalSourceTo, ProjectTrustedSourcesExternalSourceToArgs
ProjectTrustedSourcesProject, ProjectTrustedSourcesProjectArgs
- Project
Id string - The trusted Vercel project ID.
- Custom
Allows List<Pulumiverse.Vercel. Inputs. Project Trusted Sources Project Custom Allow> - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- Label string
- A label or description for the trusted project.
- Project
Id string - The trusted Vercel project ID.
- Custom
Allows []ProjectTrusted Sources Project Custom Allow - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- Label string
- A label or description for the trusted project.
- project_
id string - The trusted Vercel project ID.
- custom_
allows list(object) - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- label string
- A label or description for the trusted project.
- project
Id String - The trusted Vercel project ID.
- custom
Allows List<ProjectTrusted Sources Project Custom Allow> - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- label String
- A label or description for the trusted project.
- project
Id string - The trusted Vercel project ID.
- custom
Allows ProjectTrusted Sources Project Custom Allow[] - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- label string
- A label or description for the trusted project.
- project_
id str - The trusted Vercel project ID.
- custom_
allows Sequence[ProjectTrusted Sources Project Custom Allow] - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- label str
- A label or description for the trusted project.
- project
Id String - The trusted Vercel project ID.
- custom
Allows List<Property Map> - Optional overrides for default same-environment matching. Saved rules replace the API defaults for this trusted project.
- label String
- A label or description for the trusted project.
ProjectTrustedSourcesProjectCustomAllow, ProjectTrustedSourcesProjectCustomAllowArgs
- From
Pulumiverse.
Vercel. Inputs. Project Trusted Sources Project Custom Allow From - The source environments on the trusted project that are allowed to access the target environments.
- To
Pulumiverse.
Vercel. Inputs. Project Trusted Sources Project Custom Allow To - The target environments on this project that may be accessed.
- From
Project
Trusted Sources Project Custom Allow From - The source environments on the trusted project that are allowed to access the target environments.
- To
Project
Trusted Sources Project Custom Allow To - The target environments on this project that may be accessed.
- from
Project
Trusted Sources Project Custom Allow From - The source environments on the trusted project that are allowed to access the target environments.
- to
Project
Trusted Sources Project Custom Allow To - The target environments on this project that may be accessed.
- from
Project
Trusted Sources Project Custom Allow From - The source environments on the trusted project that are allowed to access the target environments.
- to
Project
Trusted Sources Project Custom Allow To - The target environments on this project that may be accessed.
- from_
Project
Trusted Sources Project Custom Allow From - The source environments on the trusted project that are allowed to access the target environments.
- to
Project
Trusted Sources Project Custom Allow To - The target environments on this project that may be accessed.
- from Property Map
- The source environments on the trusted project that are allowed to access the target environments.
- to Property Map
- The target environments on this project that may be accessed.
ProjectTrustedSourcesProjectCustomAllowFrom, ProjectTrustedSourcesProjectCustomAllowFromArgs
ProjectTrustedSourcesProjectCustomAllowTo, ProjectTrustedSourcesProjectCustomAllowToArgs
ProjectVercelAuthentication, ProjectVercelAuthenticationArgs
- Deployment
Type string - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
- Deployment
Type string - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
- deployment_
type string - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
- deployment
Type String - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
- deployment
Type string - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
- deployment_
type str - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
- deployment
Type String - The deployment environment to protect. The default value is
standard_protection_new(Standard Protection). Must be one ofstandard_protection_new(Standard Protection),standard_protection(Legacy Standard Protection),all_deployments,only_preview_deployments, ornone.
Import
The pulumi import command can be used, for example:
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
settingstab 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
settingstab in the Vercel UI. - project_id can be found in the project
settingstab 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
vercelTerraform Provider.
published on Wednesday, Jul 22, 2026 by Pulumiverse