Vercel v1.14.3, Oct 7 24

Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse

vercel.getProject

Explore with Pulumi AI

Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse

Example Usage

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

const foo = vercel.getProject({
    name: "my-existing-project",
});
export const projectId = foo.then(foo => foo.id);

import pulumi
import pulumi_vercel as vercel

foo = vercel.get_project(name="my-existing-project")
pulumi.export("projectId", foo.id)

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-vercel/sdk/go/vercel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		foo, err := vercel.LookupProject(ctx, &vercel.LookupProjectArgs{
			Name: "my-existing-project",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("projectId", foo.Id)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = Vercel.GetProject.Invoke(new()
    {
        Name = "my-existing-project",
    });

    return new Dictionary<string, object?>
    {
        ["projectId"] = foo.Apply(getProjectResult => getProjectResult.Id),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vercel.VercelFunctions;
import com.pulumi.vercel.inputs.GetProjectArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var foo = VercelFunctions.getProject(GetProjectArgs.builder()
            .name("my-existing-project")
            .build());

        ctx.export("projectId", foo.applyValue(getProjectResult -> getProjectResult.id()));
    }
}

variables:
  foo:
    fn::invoke:
      Function: vercel:getProject
      Arguments:
        name: my-existing-project
outputs:
  # Outputs prj_xxxxxx
  projectId: ${foo.id}

Using getProject

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>

def get_project(name: Optional[str] = None,
                team_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(name: Optional[pulumi.Input[str]] = None,
                team_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]

func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

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

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: vercel:index/getProject:getProject
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the project.
TeamId string: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

Name string: The name of the project.
TeamId string: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

name String: The name of the project.
teamId String: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

name string: The name of the project.
teamId string: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

name str: The name of the project.
team_id str: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

name String: The name of the project.
teamId String: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.

getProject Result

The following output properties are available:

AutoAssignCustomDomains bool: Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
AutomaticallyExposeSystemEnvironmentVariables bool: Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
BuildCommand string: The build command for this project. If omitted, this value will be automatically detected.
CustomerSuccessCodeVisibility bool: Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
DevCommand string: The dev command for this project. If omitted, this value will be automatically detected.
DirectoryListing bool: If no index file is present within a directory, the directory contents will be displayed.
Environments List<Pulumiverse.Vercel.Outputs.GetProjectEnvironment>: A list of environment variables that should be configured for the project.
Framework string: The framework that is being used for this project. If omitted, no framework is selected.
FunctionFailover bool: Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
GitComments Pulumiverse.Vercel.Outputs.GetProjectGitComments: Configuration for Git Comments.
GitForkProtection bool: Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
GitLfs bool: Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
GitRepository Pulumiverse.Vercel.Outputs.GetProjectGitRepository: 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.
Id string: The ID of this resource.
IgnoreCommand string: When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
InstallCommand string: The install command for this project. If omitted, this value will be automatically detected.
Name string: The name of the project.
OidcTokenConfig Pulumiverse.Vercel.Outputs.GetProjectOidcTokenConfig: Configuration for OpenID Connect (OIDC) tokens.
OptionsAllowlist Pulumiverse.Vercel.Outputs.GetProjectOptionsAllowlist: Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
OutputDirectory string: The output directory of the project. When null is used this value will be automatically detected.
PasswordProtection Pulumiverse.Vercel.Outputs.GetProjectPasswordProtection: Ensures visitors of your Preview Deployments must enter a password in order to gain access.
PreviewComments bool: Whether comments are enabled on your Preview Deployments.
PrioritiseProductionBuilds bool: If enabled, builds for the Production environment will be prioritized over Preview environments.
ProtectionBypassForAutomation bool: Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass.
PublicSource bool: Specifies whether the source code and logs of the deployments for this project should be public or not.
ResourceConfig Pulumiverse.Vercel.Outputs.GetProjectResourceConfig: Resource Configuration for the project.
RootDirectory string: The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
ServerlessFunctionRegion string: The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
SkewProtection string: Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
TeamId string: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
TrustedIps Pulumiverse.Vercel.Outputs.GetProjectTrustedIps: Ensures only visitors from an allowed IP address can access your deployment.
VercelAuthentication Pulumiverse.Vercel.Outputs.GetProjectVercelAuthentication: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

AutoAssignCustomDomains bool: Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
AutomaticallyExposeSystemEnvironmentVariables bool: Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
BuildCommand string: The build command for this project. If omitted, this value will be automatically detected.
CustomerSuccessCodeVisibility bool: Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
DevCommand string: The dev command for this project. If omitted, this value will be automatically detected.
DirectoryListing bool: If no index file is present within a directory, the directory contents will be displayed.
Environments []GetProjectEnvironment: A list of environment variables that should be configured for the project.
Framework string: The framework that is being used for this project. If omitted, no framework is selected.
FunctionFailover bool: Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
GitComments GetProjectGitComments: Configuration for Git Comments.
GitForkProtection bool: Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
GitLfs bool: Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
GitRepository GetProjectGitRepository: 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.
Id string: The ID of this resource.
IgnoreCommand string: When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
InstallCommand string: The install command for this project. If omitted, this value will be automatically detected.
Name string: The name of the project.
OidcTokenConfig GetProjectOidcTokenConfig: Configuration for OpenID Connect (OIDC) tokens.
OptionsAllowlist GetProjectOptionsAllowlist: Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
OutputDirectory string: The output directory of the project. When null is used this value will be automatically detected.
PasswordProtection GetProjectPasswordProtection: Ensures visitors of your Preview Deployments must enter a password in order to gain access.
PreviewComments bool: Whether comments are enabled on your Preview Deployments.
PrioritiseProductionBuilds bool: If enabled, builds for the Production environment will be prioritized over Preview environments.
ProtectionBypassForAutomation bool: Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass.
PublicSource bool: Specifies whether the source code and logs of the deployments for this project should be public or not.
ResourceConfig GetProjectResourceConfig: Resource Configuration for the project.
RootDirectory string: The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
ServerlessFunctionRegion string: The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
SkewProtection string: Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
TeamId string: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
TrustedIps GetProjectTrustedIps: Ensures only visitors from an allowed IP address can access your deployment.
VercelAuthentication GetProjectVercelAuthentication: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

autoAssignCustomDomains Boolean: Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
automaticallyExposeSystemEnvironmentVariables Boolean: Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
buildCommand String: The build command for this project. If omitted, this value will be automatically detected.
customerSuccessCodeVisibility Boolean: Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
devCommand String: The dev command for this project. If omitted, this value will be automatically detected.
directoryListing Boolean: If no index file is present within a directory, the directory contents will be displayed.
environments List<GetProjectEnvironment>: A list of environment variables that should be configured for the project.
framework String: The framework that is being used for this project. If omitted, no framework is selected.
functionFailover Boolean: Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
gitComments GetProjectGitComments: Configuration for Git Comments.
gitForkProtection Boolean: Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
gitLfs Boolean: Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
gitRepository GetProjectGitRepository: 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.
id String: The ID of this resource.
ignoreCommand String: When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
installCommand String: The install command for this project. If omitted, this value will be automatically detected.
name String: The name of the project.
oidcTokenConfig GetProjectOidcTokenConfig: Configuration for OpenID Connect (OIDC) tokens.
optionsAllowlist GetProjectOptionsAllowlist: Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
outputDirectory String: The output directory of the project. When null is used this value will be automatically detected.
passwordProtection GetProjectPasswordProtection: Ensures visitors of your Preview Deployments must enter a password in order to gain access.
previewComments Boolean: Whether comments are enabled on your Preview Deployments.
prioritiseProductionBuilds Boolean: If enabled, builds for the Production environment will be prioritized over Preview environments.
protectionBypassForAutomation Boolean: Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass.
publicSource Boolean: Specifies whether the source code and logs of the deployments for this project should be public or not.
resourceConfig GetProjectResourceConfig: Resource Configuration for the project.
rootDirectory String: The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
serverlessFunctionRegion String: The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
skewProtection String: Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
teamId String: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
trustedIps GetProjectTrustedIps: Ensures only visitors from an allowed IP address can access your deployment.
vercelAuthentication GetProjectVercelAuthentication: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

autoAssignCustomDomains boolean: Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
automaticallyExposeSystemEnvironmentVariables boolean: Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
buildCommand string: The build command for this project. If omitted, this value will be automatically detected.
customerSuccessCodeVisibility boolean: Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
devCommand string: The dev command for this project. If omitted, this value will be automatically detected.
directoryListing boolean: If no index file is present within a directory, the directory contents will be displayed.
environments GetProjectEnvironment[]: A list of environment variables that should be configured for the project.
framework string: The framework that is being used for this project. If omitted, no framework is selected.
functionFailover boolean: Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
gitComments GetProjectGitComments: Configuration for Git Comments.
gitForkProtection boolean: Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
gitLfs boolean: Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
gitRepository GetProjectGitRepository: 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.
id string: The ID of this resource.
ignoreCommand string: When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
installCommand string: The install command for this project. If omitted, this value will be automatically detected.
name string: The name of the project.
oidcTokenConfig GetProjectOidcTokenConfig: Configuration for OpenID Connect (OIDC) tokens.
optionsAllowlist GetProjectOptionsAllowlist: Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
outputDirectory string: The output directory of the project. When null is used this value will be automatically detected.
passwordProtection GetProjectPasswordProtection: Ensures visitors of your Preview Deployments must enter a password in order to gain access.
previewComments boolean: Whether comments are enabled on your Preview Deployments.
prioritiseProductionBuilds boolean: If enabled, builds for the Production environment will be prioritized over Preview environments.
protectionBypassForAutomation boolean: Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass.
publicSource boolean: Specifies whether the source code and logs of the deployments for this project should be public or not.
resourceConfig GetProjectResourceConfig: Resource Configuration for the project.
rootDirectory string: The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
serverlessFunctionRegion string: The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
skewProtection string: Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
teamId string: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
trustedIps GetProjectTrustedIps: Ensures only visitors from an allowed IP address can access your deployment.
vercelAuthentication GetProjectVercelAuthentication: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

auto_assign_custom_domains bool: Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
automatically_expose_system_environment_variables bool: Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
build_command str: The build command for this project. If omitted, this value will be automatically detected.
customer_success_code_visibility bool: Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
dev_command str: The dev command for this project. If omitted, this value will be automatically detected.
directory_listing bool: If no index file is present within a directory, the directory contents will be displayed.
environments Sequence[GetProjectEnvironment]: A list 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 GetProjectGitComments: Configuration for Git Comments.
git_fork_protection bool: Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
git_lfs bool: Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
git_repository GetProjectGitRepository: 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.
id str: The ID of this resource.
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 name of the project.
oidc_token_config GetProjectOidcTokenConfig: Configuration for OpenID Connect (OIDC) tokens.
options_allowlist GetProjectOptionsAllowlist: Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
output_directory str: The output directory of the project. When null is used this value will be automatically detected.
password_protection GetProjectPasswordProtection: Ensures visitors of your Preview Deployments must enter a password in order to gain access.
preview_comments bool: Whether comments are enabled on your Preview Deployments.
prioritise_production_builds bool: If enabled, builds for the Production environment will be prioritized over Preview environments.
protection_bypass_for_automation bool: Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass.
public_source bool: Specifies whether the source code and logs of the deployments for this project should be public or not.
resource_config GetProjectResourceConfig: Resource Configuration for the project.
root_directory str: The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
serverless_function_region str: The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
skew_protection str: Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
team_id str: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
trusted_ips GetProjectTrustedIps: Ensures only visitors from an allowed IP address can access your deployment.
vercel_authentication GetProjectVercelAuthentication: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

autoAssignCustomDomains Boolean: Automatically assign custom production domains after each Production deployment via merge to the production branch or Vercel CLI deploy with --prod. Defaults to true
automaticallyExposeSystemEnvironmentVariables Boolean: Vercel provides a set of Environment Variables that are automatically populated by the System, such as the URL of the Deployment or the name of the Git branch deployed. To expose them to your Deployments, enable this field
buildCommand String: The build command for this project. If omitted, this value will be automatically detected.
customerSuccessCodeVisibility Boolean: Allows Vercel Customer Support to inspect all Deployments' source code in this project to assist with debugging.
devCommand String: The dev command for this project. If omitted, this value will be automatically detected.
directoryListing Boolean: If no index file is present within a directory, the directory contents will be displayed.
environments List<Property Map>: A list of environment variables that should be configured for the project.
framework String: The framework that is being used for this project. If omitted, no framework is selected.
functionFailover Boolean: Automatically failover Serverless Functions to the nearest region. You can customize regions through vercel.json. A new Deployment is required for your changes to take effect.
gitComments Property Map: Configuration for Git Comments.
gitForkProtection Boolean: Ensures that pull requests targeting your Git repository must be authorized by a member of your Team before deploying if your Project has Environment Variables or if the pull request includes a change to vercel.json.
gitLfs Boolean: Enables Git LFS support. Git LFS replaces large files such as audio samples, videos, datasets, and graphics with text pointers inside Git, while storing the file contents on a remote server like GitHub.com or GitHub Enterprise.
gitRepository Property Map: The Git Repository that will be connected to the project. When this is defined, any pushes to the specified connected Git Repository will be automatically deployed. This requires the corresponding Vercel for Github, Gitlab or Bitbucket plugins to be installed.
id String: The ID of this resource.
ignoreCommand String: When a commit is pushed to the Git repository that is connected with your Project, its SHA will determine if a new Build has to be issued. If the SHA was deployed before, no new Build will be issued. You can customize this behavior with a command that exits with code 1 (new Build needed) or code 0.
installCommand String: The install command for this project. If omitted, this value will be automatically detected.
name String: The name of the project.
oidcTokenConfig Property Map: Configuration for OpenID Connect (OIDC) tokens.
optionsAllowlist Property Map: Disable Deployment Protection for CORS preflight OPTIONS requests for a list of paths.
outputDirectory String: The output directory of the project. When null is used this value will be automatically detected.
passwordProtection Property Map: Ensures visitors of your Preview Deployments must enter a password in order to gain access.
previewComments Boolean: Whether comments are enabled on your Preview Deployments.
prioritiseProductionBuilds Boolean: If enabled, builds for the Production environment will be prioritized over Preview environments.
protectionBypassForAutomation Boolean: Allows automation services to bypass Vercel Authentication and Password Protection for both Preview and Production Deployments on this project when using an HTTP header named x-vercel-protection-bypass.
publicSource Boolean: Specifies whether the source code and logs of the deployments for this project should be public or not.
resourceConfig Property Map: Resource Configuration for the project.
rootDirectory String: The name of a directory or relative path to the source code of your project. When null is used it will default to the project root.
serverlessFunctionRegion String: The region on Vercel's network to which your Serverless Functions are deployed. It should be close to any data source your Serverless Function might depend on. A new Deployment is required for your changes to take effect. Please see Vercel's documentation for a full list of regions.
skewProtection String: Ensures that outdated clients always fetch the correct version for a given deployment. This value defines how long Vercel keeps Skew Protection active.
teamId String: The team ID the project exists beneath. Required when configuring a team resource if a default team has not been set in the provider.
trustedIps Property Map: Ensures only visitors from an allowed IP address can access your deployment.
vercelAuthentication Property Map: Ensures visitors to your Preview Deployments are logged into Vercel and have a minimum of Viewer access on your team.

Supporting Types

GetProjectEnvironment

GitBranch string: The git branch of the environment variable.
Id string: The ID of the environment variable
Key string: The name of the environment variable.
Sensitive bool: Whether the Environment Variable is sensitive or not. Note that the value will be null for sensitive environment variables.
Targets List<string>: The environments that the environment variable should be present on. Valid targets are either production, preview, or development.
Value string: The value of the environment variable.

GitBranch string: The git branch of the environment variable.
Id string: The ID of the environment variable
Key string: The name of the environment variable.
Sensitive bool: Whether the Environment Variable is sensitive or not. Note that the value will be null for sensitive environment variables.
Targets []string: The environments that the environment variable should be present on. Valid targets are either production, preview, or development.
Value string: The value of the environment variable.

gitBranch String: The git branch of the environment variable.
id String: The ID of the environment variable
key String: The name of the environment variable.
sensitive Boolean: Whether the Environment Variable is sensitive or not. Note that the value will be null for sensitive environment variables.
targets List<String>: The environments that the environment variable should be present on. Valid targets are either production, preview, or development.
value String: The value of the environment variable.

gitBranch string: The git branch of the environment variable.
id string: The ID of the environment variable
key string: The name of the environment variable.
sensitive boolean: Whether the Environment Variable is sensitive or not. Note that the value will be null for sensitive environment variables.
targets string[]: The environments that the environment variable should be present on. Valid targets are either production, preview, or development.
value string: The value of the environment variable.

git_branch str: The git branch of the environment variable.
id str: The ID of the environment variable
key str: The name of the environment variable.
sensitive bool: Whether the Environment Variable is sensitive or not. Note that the value will be null for sensitive environment variables.
targets Sequence[str]: The environments that the environment variable should be present on. Valid targets are either production, preview, or development.
value str: The value of the environment variable.

gitBranch String: The git branch of the environment variable.
id String: The ID of the environment variable
key String: The name of the environment variable.
sensitive Boolean: Whether the Environment Variable is sensitive or not. Note that the value will be null for sensitive environment variables.
targets List<String>: The environments that the environment variable should be present on. Valid targets are either production, preview, or development.
value String: The value of the environment variable.

GetProjectGitComments

OnCommit bool: Whether Commit comments are enabled
OnPullRequest bool: Whether Pull Request comments are enabled

OnCommit bool: Whether Commit comments are enabled
OnPullRequest bool: Whether Pull Request comments are enabled

onCommit Boolean: Whether Commit comments are enabled
onPullRequest Boolean: Whether Pull Request comments are enabled

onCommit boolean: Whether Commit comments are enabled
onPullRequest boolean: Whether Pull Request comments are enabled

on_commit bool: Whether Commit comments are enabled
on_pull_request bool: Whether Pull Request comments are enabled

onCommit Boolean: Whether Commit comments are enabled
onPullRequest Boolean: Whether Pull Request comments are enabled

GetProjectGitRepository

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

DeployHooks []GetProjectGitRepositoryDeployHook: Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
ProductionBranch string: By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
Repo string: The name of the git repository. For example: vercel/next.js.
Type string: The git provider of the repository. Must be either github, gitlab, or bitbucket.

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

deployHooks GetProjectGitRepositoryDeployHook[]: Deploy hooks are unique URLs that allow you to trigger a deployment of a given branch. See https://vercel.com/docs/deployments/deploy-hooks for full information.
productionBranch string: By default, every commit pushed to the main branch will trigger a Production Deployment instead of the usual Preview Deployment. You can switch to a different branch here.
repo string: The name of the git repository. For example: vercel/next.js.
type string: The git provider of the repository. Must be either github, gitlab, or bitbucket.

deploy_hooks Sequence[GetProjectGitRepositoryDeployHook]: 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 str: The name of the git repository. For example: vercel/next.js.
type str: The git provider of the repository. Must be either github, gitlab, or bitbucket.

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

GetProjectGitRepositoryDeployHook

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

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

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

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

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

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

GetProjectOidcTokenConfig

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

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

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

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

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

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

GetProjectOptionsAllowlist

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

Paths []GetProjectOptionsAllowlistPath: The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.

paths List<GetProjectOptionsAllowlistPath>: The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.

paths GetProjectOptionsAllowlistPath[]: The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.

paths Sequence[GetProjectOptionsAllowlistPath]: The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.

paths List<Property Map>: The allowed paths for the OPTIONS Allowlist. Incoming requests will bypass Deployment Protection if they have the method OPTIONS and start with one of the path values.

GetProjectOptionsAllowlistPath

Value string

Value string

value String

value string

value str

value String

GetProjectPasswordProtection

DeploymentType string: The deployment environment that will be protected.

DeploymentType string: The deployment environment that will be protected.

deploymentType String: The deployment environment that will be protected.

deploymentType string: The deployment environment that will be protected.

deployment_type str: The deployment environment that will be protected.

deploymentType String: The deployment environment that will be protected.

GetProjectResourceConfig

FunctionDefaultCpuType string: The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
FunctionDefaultTimeout int: The default timeout for Serverless Functions.

FunctionDefaultCpuType string: The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
FunctionDefaultTimeout int: The default timeout for Serverless Functions.

functionDefaultCpuType String: The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
functionDefaultTimeout Integer: The default timeout for Serverless Functions.

functionDefaultCpuType string: The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
functionDefaultTimeout number: The default timeout for Serverless Functions.

function_default_cpu_type str: The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
function_default_timeout int: The default timeout for Serverless Functions.

functionDefaultCpuType String: The amount of CPU available to your Serverless Functions. Should be one of 'standard_legacy' (0.6vCPU), 'standard' (1vCPU) or 'performance' (1.7vCPUs).
functionDefaultTimeout Number: The default timeout for Serverless Functions.

GetProjectTrustedIps

Addresses List<Pulumiverse.Vercel.Inputs.GetProjectTrustedIpsAddress>: The allowed IP addressses and CIDR ranges with optional descriptions.
DeploymentType string: The deployment environment that will be protected.
ProtectionMode string: Whether or not Trusted IPs is required or optional to access a deployment.

Addresses []GetProjectTrustedIpsAddress: The allowed IP addressses and CIDR ranges with optional descriptions.
DeploymentType string: The deployment environment that will be protected.
ProtectionMode string: Whether or not Trusted IPs is required or optional to access a deployment.

addresses List<GetProjectTrustedIpsAddress>: The allowed IP addressses and CIDR ranges with optional descriptions.
deploymentType String: The deployment environment that will be protected.
protectionMode String: Whether or not Trusted IPs is required or optional to access a deployment.

addresses GetProjectTrustedIpsAddress[]: The allowed IP addressses and CIDR ranges with optional descriptions.
deploymentType string: The deployment environment that will be protected.
protectionMode string: Whether or not Trusted IPs is required or optional to access a deployment.

addresses Sequence[GetProjectTrustedIpsAddress]: The allowed IP addressses and CIDR ranges with optional descriptions.
deployment_type str: The deployment environment that will be protected.
protection_mode str: Whether or not Trusted IPs is required or optional to access a deployment.

addresses List<Property Map>: The allowed IP addressses and CIDR ranges with optional descriptions.
deploymentType String: The deployment environment that will be protected.
protectionMode String: Whether or not Trusted IPs is required or optional to access a deployment.

GetProjectTrustedIpsAddress

Note string
Value string

Note string
Value string

note String
value String

note string
value string

note str
value str

note String
value String

GetProjectVercelAuthentication

DeploymentType string: The deployment environment that will be protected.

DeploymentType string: The deployment environment that will be protected.

deploymentType String: The deployment environment that will be protected.

deploymentType string: The deployment environment that will be protected.

deployment_type str: The deployment environment that will be protected.

deploymentType String: The deployment environment that will be protected.

Package Details

Repository: vercel pulumiverse/pulumi-vercel
License: Apache-2.0
Notes: This Pulumi package is based on the vercel Terraform Provider.

Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse

pulumiverse/pulumi-vercel

vercel.getProject

On this page

On this page

Example Usage

Using getProject

getProject Result

Supporting Types

GetProjectEnvironment

GetProjectGitComments

GetProjectGitRepository

GetProjectGitRepositoryDeployHook

GetProjectOidcTokenConfig

GetProjectOptionsAllowlist

GetProjectOptionsAllowlistPath

GetProjectPasswordProtection

GetProjectResourceConfig

GetProjectTrustedIps

GetProjectTrustedIpsAddress

GetProjectVercelAuthentication

Package Details

On this page

On this page