Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. ProjectDomain
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

vercel.ProjectDomain

vercel logo vercel logo
Viewing docs for Vercel v5.21.1
published on Thursday, Oct 15, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

    Provides a Project Domain resource.

    A Project Domain is used to associate a domain name with a vercel.Project.

    By default, Project Domains will be automatically applied to any production deployments.

    Example Usage

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

const example = new vercel.Project("example", {name: "example-project"});
// A simple domain that will be automatically
// applied to each production deployment
const exampleProjectDomain = new vercel.ProjectDomain("example", {
    projectId: example.id,
    domain: "i-love.vercel.app",
});
// Wait for the domain to be verified before resources that depend on it run.
const exampleWaitForReady = new vercel.ProjectDomain("example_wait_for_ready", {
    projectId: example.id,
    domain: "i-wait.vercel.app",
    waitForReady: true,
});
// A redirect of a domain name to a second domain name.
// The status_code can optionally be controlled.
const exampleRedirect = new vercel.ProjectDomain("example_redirect", {
    projectId: example.id,
    domain: "i-also-love.vercel.app",
    redirect: exampleProjectDomain.domain,
    redirectStatusCode: 307,
});

    import pulumi
import pulumiverse_vercel as vercel

example = vercel.Project("example", name="example-project")
# A simple domain that will be automatically
# applied to each production deployment
example_project_domain = vercel.ProjectDomain("example",
    project_id=example.id,
    domain="i-love.vercel.app")
# Wait for the domain to be verified before resources that depend on it run.
example_wait_for_ready = vercel.ProjectDomain("example_wait_for_ready",
    project_id=example.id,
    domain="i-wait.vercel.app",
    wait_for_ready=True)
# A redirect of a domain name to a second domain name.
# The status_code can optionally be controlled.
example_redirect = vercel.ProjectDomain("example_redirect",
    project_id=example.id,
    domain="i-also-love.vercel.app",
    redirect=example_project_domain.domain,
    redirect_status_code=307)

    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 {
		example, err := vercel.NewProject(ctx, "example", &vercel.ProjectArgs{
			Name: pulumi.String("example-project"),
		})
		if err != nil {
			return err
		}
		// A simple domain that will be automatically
		// applied to each production deployment
		exampleProjectDomain, err := vercel.NewProjectDomain(ctx, "example", &vercel.ProjectDomainArgs{
			ProjectId: example.ID(),
			Domain:    pulumi.String("i-love.vercel.app"),
		})
		if err != nil {
			return err
		}
		// Wait for the domain to be verified before resources that depend on it run.
		_, err = vercel.NewProjectDomain(ctx, "example_wait_for_ready", &vercel.ProjectDomainArgs{
			ProjectId:    example.ID(),
			Domain:       pulumi.String("i-wait.vercel.app"),
			WaitForReady: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		// A redirect of a domain name to a second domain name.
		// The status_code can optionally be controlled.
		_, err = vercel.NewProjectDomain(ctx, "example_redirect", &vercel.ProjectDomainArgs{
			ProjectId:          example.ID(),
			Domain:             pulumi.String("i-also-love.vercel.app"),
			Redirect:           exampleProjectDomain.Domain,
			RedirectStatusCode: pulumi.Int(307),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Vercel.Project("example", new()
    {
        Name = "example-project",
    });

    // A simple domain that will be automatically
    // applied to each production deployment
    var exampleProjectDomain = new Vercel.ProjectDomain("example", new()
    {
        ProjectId = example.Id,
        Domain = "i-love.vercel.app",
    });

    // Wait for the domain to be verified before resources that depend on it run.
    var exampleWaitForReady = new Vercel.ProjectDomain("example_wait_for_ready", new()
    {
        ProjectId = example.Id,
        Domain = "i-wait.vercel.app",
        WaitForReady = true,
    });

    // A redirect of a domain name to a second domain name.
    // The status_code can optionally be controlled.
    var exampleRedirect = new Vercel.ProjectDomain("example_redirect", new()
    {
        ProjectId = example.Id,
        Domain = "i-also-love.vercel.app",
        Redirect = exampleProjectDomain.Domain,
        RedirectStatusCode = 307,
    });

});

    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.pulumiverse.vercel.ProjectDomain;
import com.pulumiverse.vercel.ProjectDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new Project("example", ProjectArgs.builder()
            .name("example-project")
            .build());

        // A simple domain that will be automatically
        // applied to each production deployment
        var exampleProjectDomain = new ProjectDomain("exampleProjectDomain", ProjectDomainArgs.builder()
            .projectId(example.id())
            .domain("i-love.vercel.app")
            .build());

        // Wait for the domain to be verified before resources that depend on it run.
        var exampleWaitForReady = new ProjectDomain("exampleWaitForReady", ProjectDomainArgs.builder()
            .projectId(example.id())
            .domain("i-wait.vercel.app")
            .waitForReady(true)
            .build());

        // A redirect of a domain name to a second domain name.
        // The status_code can optionally be controlled.
        var exampleRedirect = new ProjectDomain("exampleRedirect", ProjectDomainArgs.builder()
            .projectId(example.id())
            .domain("i-also-love.vercel.app")
            .redirect(exampleProjectDomain.domain())
            .redirectStatusCode(307)
            .build());

    }
}

    resources:
  example:
    type: vercel:Project
    properties:
      name: example-project
  # A simple domain that will be automatically
  # applied to each production deployment
  exampleProjectDomain:
    type: vercel:ProjectDomain
    name: example
    properties:
      projectId: ${example.id}
      domain: i-love.vercel.app
  # Wait for the domain to be verified before resources that depend on it run.
  exampleWaitForReady:
    type: vercel:ProjectDomain
    name: example_wait_for_ready
    properties:
      projectId: ${example.id}
      domain: i-wait.vercel.app
      waitForReady: true
  # A redirect of a domain name to a second domain name.
  # The status_code can optionally be controlled.
  exampleRedirect:
    type: vercel:ProjectDomain
    name: example_redirect
    properties:
      projectId: ${example.id}
      domain: i-also-love.vercel.app
      redirect: ${exampleProjectDomain.domain}
      redirectStatusCode: 307

    Example coming soon!

    Create ProjectDomain Resource

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

    Constructor syntax

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

@overload
def ProjectDomain(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  domain: Optional[str] = None,
                  project_id: Optional[str] = None,
                  custom_environment_id: Optional[str] = None,
                  git_branch: Optional[str] = None,
                  redirect: Optional[str] = None,
                  redirect_status_code: Optional[int] = None,
                  team_id: Optional[str] = None,
                  wait_for_ready: Optional[bool] = None)
    func NewProjectDomain(ctx *Context, name string, args ProjectDomainArgs, opts ...ResourceOption) (*ProjectDomain, error)
    public ProjectDomain(string name, ProjectDomainArgs args, CustomResourceOptions? opts = null)
    public ProjectDomain(String name, ProjectDomainArgs args)
public ProjectDomain(String name, ProjectDomainArgs args, CustomResourceOptions options)

    type: vercel:ProjectDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vercel_project_domain" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ProjectDomainArgs
    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 ProjectDomainArgs
    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 ProjectDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectDomainArgs
    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 projectDomainResource = new Vercel.ProjectDomain("projectDomainResource", new()
{
    Domain = "string",
    ProjectId = "string",
    CustomEnvironmentId = "string",
    GitBranch = "string",
    Redirect = "string",
    RedirectStatusCode = 0,
    TeamId = "string",
    WaitForReady = false,
});

    example, err := vercel.NewProjectDomain(ctx, "projectDomainResource", &vercel.ProjectDomainArgs{
	Domain:              pulumi.String("string"),
	ProjectId:           pulumi.String("string"),
	CustomEnvironmentId: pulumi.String("string"),
	GitBranch:           pulumi.String("string"),
	Redirect:            pulumi.String("string"),
	RedirectStatusCode:  pulumi.Int(0),
	TeamId:              pulumi.String("string"),
	WaitForReady:        pulumi.Bool(false),
})

    resource "vercel_project_domain" "projectDomainResource" {
  lifecycle {
    create_before_destroy = true
  }
  domain                = "string"
  project_id            = "string"
  custom_environment_id = "string"
  git_branch            = "string"
  redirect              = "string"
  redirect_status_code  = 0
  team_id               = "string"
  wait_for_ready        = false
}

    var projectDomainResource = new ProjectDomain("projectDomainResource", ProjectDomainArgs.builder()
    .domain("string")
    .projectId("string")
    .customEnvironmentId("string")
    .gitBranch("string")
    .redirect("string")
    .redirectStatusCode(0)
    .teamId("string")
    .waitForReady(false)
    .build());

    project_domain_resource = vercel.ProjectDomain("projectDomainResource",
    domain="string",
    project_id="string",
    custom_environment_id="string",
    git_branch="string",
    redirect="string",
    redirect_status_code=0,
    team_id="string",
    wait_for_ready=False)

    const projectDomainResource = new vercel.ProjectDomain("projectDomainResource", {
    domain: "string",
    projectId: "string",
    customEnvironmentId: "string",
    gitBranch: "string",
    redirect: "string",
    redirectStatusCode: 0,
    teamId: "string",
    waitForReady: false,
});

    type: vercel:ProjectDomain
properties:
    customEnvironmentId: string
    domain: string
    gitBranch: string
    projectId: string
    redirect: string
    redirectStatusCode: 0
    teamId: string
    waitForReady: false

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

    Domain string
    The domain name to associate with the project.
    ProjectId string
    The project ID to add the deployment to.
    CustomEnvironmentId string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    GitBranch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    Redirect string
    The domain name that serves as a target destination for redirects.
    RedirectStatusCode int
    The HTTP status code to use when serving as a redirect.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    WaitForReady bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    Domain string
    The domain name to associate with the project.
    ProjectId string
    The project ID to add the deployment to.
    CustomEnvironmentId string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    GitBranch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    Redirect string
    The domain name that serves as a target destination for redirects.
    RedirectStatusCode int
    The HTTP status code to use when serving as a redirect.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    WaitForReady bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    domain string
    The domain name to associate with the project.
    project_id string
    The project ID to add the deployment to.
    custom_environment_id string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    git_branch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    redirect string
    The domain name that serves as a target destination for redirects.
    redirect_status_code number
    The HTTP status code to use when serving as a redirect.
    team_id string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    wait_for_ready bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    domain String
    The domain name to associate with the project.
    projectId String
    The project ID to add the deployment to.
    customEnvironmentId String
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    gitBranch String
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    redirect String
    The domain name that serves as a target destination for redirects.
    redirectStatusCode Integer
    The HTTP status code to use when serving as a redirect.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    waitForReady Boolean
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    domain string
    The domain name to associate with the project.
    projectId string
    The project ID to add the deployment to.
    customEnvironmentId string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    gitBranch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    redirect string
    The domain name that serves as a target destination for redirects.
    redirectStatusCode number
    The HTTP status code to use when serving as a redirect.
    teamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    waitForReady boolean
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    domain str
    The domain name to associate with the project.
    project_id str
    The project ID to add the deployment to.
    custom_environment_id str
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    git_branch str
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    redirect str
    The domain name that serves as a target destination for redirects.
    redirect_status_code int
    The HTTP status code to use when serving as a redirect.
    team_id str
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    wait_for_ready bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    domain String
    The domain name to associate with the project.
    projectId String
    The project ID to add the deployment to.
    customEnvironmentId String
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    gitBranch String
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    redirect String
    The domain name that serves as a target destination for redirects.
    redirectStatusCode Number
    The HTTP status code to use when serving as a redirect.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    waitForReady Boolean
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    Verifications List<Pulumiverse.Vercel.Outputs.ProjectDomainVerification>
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    Verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    Id string
    The provider-assigned unique ID for this managed resource.
    Misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    Verifications []ProjectDomainVerification
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    Verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    id string
    The provider-assigned unique ID for this managed resource.
    misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    verifications list(object)
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    id String
    The provider-assigned unique ID for this managed resource.
    misconfigured Boolean
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    verifications List<ProjectDomainVerification>
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified Boolean
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    id string
    The provider-assigned unique ID for this managed resource.
    misconfigured boolean
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    verifications ProjectDomainVerification[]
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified boolean
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    id str
    The provider-assigned unique ID for this managed resource.
    misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    verifications Sequence[ProjectDomainVerification]
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    id String
    The provider-assigned unique ID for this managed resource.
    misconfigured Boolean
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    verifications List<Property Map>
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified Boolean
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.

    Look up Existing ProjectDomain Resource

    Get an existing ProjectDomain 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?: ProjectDomainState, opts?: CustomResourceOptions): ProjectDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        custom_environment_id: Optional[str] = None,
        domain: Optional[str] = None,
        git_branch: Optional[str] = None,
        misconfigured: Optional[bool] = None,
        project_id: Optional[str] = None,
        redirect: Optional[str] = None,
        redirect_status_code: Optional[int] = None,
        team_id: Optional[str] = None,
        verifications: Optional[Sequence[ProjectDomainVerificationArgs]] = None,
        verified: Optional[bool] = None,
        wait_for_ready: Optional[bool] = None) -> ProjectDomain
    func GetProjectDomain(ctx *Context, name string, id IDInput, state *ProjectDomainState, opts ...ResourceOption) (*ProjectDomain, error)
    public static ProjectDomain Get(string name, Input<string> id, ProjectDomainState? state, CustomResourceOptions? opts = null)
    public static ProjectDomain get(String name, Output<String> id, ProjectDomainState state, CustomResourceOptions options)
    resources:  _:    type: vercel:ProjectDomain    get:      id: ${id}
    import {
  to = vercel_project_domain.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.
    The following state arguments are supported:
    CustomEnvironmentId string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    Domain string
    The domain name to associate with the project.
    GitBranch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    Misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    ProjectId string
    The project ID to add the deployment to.
    Redirect string
    The domain name that serves as a target destination for redirects.
    RedirectStatusCode int
    The HTTP status code to use when serving as a redirect.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    Verifications List<Pulumiverse.Vercel.Inputs.ProjectDomainVerification>
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    Verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    WaitForReady bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    CustomEnvironmentId string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    Domain string
    The domain name to associate with the project.
    GitBranch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    Misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    ProjectId string
    The project ID to add the deployment to.
    Redirect string
    The domain name that serves as a target destination for redirects.
    RedirectStatusCode int
    The HTTP status code to use when serving as a redirect.
    TeamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    Verifications []ProjectDomainVerificationArgs
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    Verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    WaitForReady bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    custom_environment_id string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    domain string
    The domain name to associate with the project.
    git_branch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    project_id string
    The project ID to add the deployment to.
    redirect string
    The domain name that serves as a target destination for redirects.
    redirect_status_code number
    The HTTP status code to use when serving as a redirect.
    team_id string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    verifications list(object)
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    wait_for_ready bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    customEnvironmentId String
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    domain String
    The domain name to associate with the project.
    gitBranch String
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    misconfigured Boolean
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    projectId String
    The project ID to add the deployment to.
    redirect String
    The domain name that serves as a target destination for redirects.
    redirectStatusCode Integer
    The HTTP status code to use when serving as a redirect.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    verifications List<ProjectDomainVerification>
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified Boolean
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    waitForReady Boolean
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    customEnvironmentId string
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    domain string
    The domain name to associate with the project.
    gitBranch string
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    misconfigured boolean
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    projectId string
    The project ID to add the deployment to.
    redirect string
    The domain name that serves as a target destination for redirects.
    redirectStatusCode number
    The HTTP status code to use when serving as a redirect.
    teamId string
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    verifications ProjectDomainVerification[]
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified boolean
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    waitForReady boolean
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    custom_environment_id str
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    domain str
    The domain name to associate with the project.
    git_branch str
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    misconfigured bool
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    project_id str
    The project ID to add the deployment to.
    redirect str
    The domain name that serves as a target destination for redirects.
    redirect_status_code int
    The HTTP status code to use when serving as a redirect.
    team_id str
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    verifications Sequence[ProjectDomainVerificationArgs]
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified bool
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    wait_for_ready bool
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.
    customEnvironmentId String
    The name of the Custom Environment to link to the Project Domain. Deployments from this custom environment will be assigned the domain name.
    domain String
    The domain name to associate with the project.
    gitBranch String
    Git branch to link to the project domain. Deployments from this git branch will be assigned the domain name.
    misconfigured Boolean
    Whether the domain has an invalid DNS configuration or Vercel cannot automatically generate a TLS certificate for it.
    projectId String
    The project ID to add the deployment to.
    redirect String
    The domain name that serves as a target destination for redirects.
    redirectStatusCode Number
    The HTTP status code to use when serving as a redirect.
    teamId String
    The ID of the team the project exists under. Required when configuring a team resource if a default team has not been set in the provider.
    verifications List<Property Map>
    A list of ownership verification challenges, one of which must be completed to verify the domain for use with the project. These are typically TXT records and do not describe the A or CNAME records needed to route traffic to Vercel.
    verified Boolean
    Whether ownership of the domain is verified for use with the project. This does not indicate whether the domain's DNS records point to Vercel; use misconfigured for that status.
    waitForReady Boolean
    Wait until the project domain is verified and has a valid DNS configuration before considering it created. DNS records must be configured independently before enabling this option because dependent resources are not created until the wait completes.

    Supporting Types

    ProjectDomainVerification, ProjectDomainVerificationArgs

    Domain string
    The domain name on which the DNS record must be created.
    Reason string
    A human-readable explanation of why this challenge was issued.
    Type string
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    Value string
    The value that the DNS record must contain.
    Domain string
    The domain name on which the DNS record must be created.
    Reason string
    A human-readable explanation of why this challenge was issued.
    Type string
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    Value string
    The value that the DNS record must contain.
    domain string
    The domain name on which the DNS record must be created.
    reason string
    A human-readable explanation of why this challenge was issued.
    type string
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    value string
    The value that the DNS record must contain.
    domain String
    The domain name on which the DNS record must be created.
    reason String
    A human-readable explanation of why this challenge was issued.
    type String
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    value String
    The value that the DNS record must contain.
    domain string
    The domain name on which the DNS record must be created.
    reason string
    A human-readable explanation of why this challenge was issued.
    type string
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    value string
    The value that the DNS record must contain.
    domain str
    The domain name on which the DNS record must be created.
    reason str
    A human-readable explanation of why this challenge was issued.
    type str
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    value str
    The value that the DNS record must contain.
    domain String
    The domain name on which the DNS record must be created.
    reason String
    A human-readable explanation of why this challenge was issued.
    type String
    The type of DNS record that must be created to satisfy the challenge (e.g. TXT).
    value String
    The value that the DNS record must contain.

    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 and domain.

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

    Alternatively, you can import via the team_id, project_id and domain name.

    • team_id can be found in the team settings tab in the Vercel UI.
    • project_id can be found in the project settings tab in the Vercel UI.
    $ pulumi import vercel:index/projectDomain:ProjectDomain example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/example.com

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo vercel logo
    Viewing docs for Vercel v5.21.1
    published on Thursday, Oct 15, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-vercel

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial