vercel.Deployment

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

// In this example, we are assuming that a nextjs UI
// exists in a `ui` directory and any terraform exists in a `terraform` directory.
// E.g.
// ```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="python">

```python
import pulumi
import pulumi_vercel as vercel
import pulumiverse_vercel as vercel

# In this example, we are assuming that a nextjs UI
# exists in a `ui` directory and any terraform exists in a `terraform` directory.
# E.g.
# ```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="go">

```go
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 {
		// In this example, we are assuming that a nextjs UI
		// exists in a `ui` directory and any terraform exists in a `terraform` directory.
		// E.g.
		// ```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="csharp">

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

return await Deployment.RunAsync(() => 
{
    // In this example, we are assuming that a nextjs UI
    // exists in a `ui` directory and any terraform exists in a `terraform` directory.
    // E.g.
    // ```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="java">

```java
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.GetProjectDirectoryArgs;
import com.pulumi.vercel.inputs.GetProjectArgs;
import com.pulumiverse.vercel.Deployment;
import com.pulumiverse.vercel.DeploymentArgs;
import com.pulumiverse.vercel.Project;
import com.pulumiverse.vercel.ProjectArgs;
import com.pulumi.vercel.inputs.ProjectGitRepositoryArgs;
import com.pulumi.vercel.inputs.GetPrebuiltProjectArgs;
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) {
        // In this example, we are assuming that a nextjs UI
        // exists in a `ui` directory and any terraform exists in a `terraform` directory.
        // E.g.
        // ```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="yaml">

```yaml
resources:
  filesExampleDeployment:
    type: vercel:Deployment
    name: files_example
    properties:
      projectId: ${filesExampleGetProject.id}
      files: ${filesExample.files}
      pathPrefix: ${filesExample.path}
      production: true
      environment:
        FOO: bar
  ## Or deploying a specific commit or branch
  gitExample:
    type: vercel:Project
    name: git_example
    properties:
      name: my-awesome-git-project
      framework: nextjs
      gitRepository:
        type: github
        repo: vercel/some-repo
  gitExampleDeployment:
    type: vercel:Deployment
    name: git_example
    properties:
      projectId: ${gitExample.id}
      ref: d92f10e
  prebuiltExampleDeployment:
    type: vercel:Deployment
    name: prebuilt_example
    properties:
      projectId: ${prebuiltExample.id}
      files: ${prebuiltExampleGetPrebuiltProject.output}
      pathPrefix: ${prebuiltExampleGetPrebuiltProject.path}
variables:
  # In this example, we are assuming that a nextjs UI
  # exists in a `ui` directory and any terraform exists in a `terraform` directory.
  # E.g.
  # ```
</pulumi-choosable>
</div>
<div>
<pulumi-choosable type="language" values="hcl">

Example coming soon!

</pulumi-choosable>
</div>




## Create Deployment Resource {#create}

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see [Resources](/docs/concepts/resources/).

### Constructor syntax
<div>
<pulumi-chooser type="language" options="csharp,go,typescript,python,yaml,java,hcl"></pulumi-chooser>
</div>


<div>
<pulumi-choosable type="language" values="javascript,typescript">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-typescript" data-lang="typescript"><span class="k">new </span><span class="nx">Deployment</span><span class="p">(</span><span class="nx">name</span><span class="p">:</span> <span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">DeploymentArgs</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p">?:</span> <span class="nx"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span><span class="p">);</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="python">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-python" data-lang="python"><span class=nd>@overload</span>
<span class="k">def </span><span class="nx">Deployment</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span>
               <span class="nx">args</span><span class="p">:</span> <span class="nx"><a href="#inputs">DeploymentArgs</a></span><span class="p">,</span>
               <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">)</span>
<span></span>
<span class=nd>@overload</span>
<span class="k">def </span><span class="nx">Deployment</span><span class="p">(</span><span class="nx">resource_name</span><span class="p">:</span> <span class="nx">str</span><span class="p">,</span>
               <span class="nx">opts</span><span class="p">:</span> <span class="nx"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">Optional[ResourceOptions]</a></span> = None<span class="p">,</span>
               <span class="nx">project_id</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
               <span class="nx">custom_environment_id</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
               <span class="nx">delete_on_destroy</span><span class="p">:</span> <span class="nx">Optional[bool]</span> = None<span class="p">,</span>
               <span class="nx">environment</span><span class="p">:</span> <span class="nx">Optional[Mapping[str, str]]</span> = None<span class="p">,</span>
               <span class="nx">files</span><span class="p">:</span> <span class="nx">Optional[Mapping[str, str]]</span> = None<span class="p">,</span>
               <span class="nx">meta</span><span class="p">:</span> <span class="nx">Optional[Mapping[str, str]]</span> = None<span class="p">,</span>
               <span class="nx">path_prefix</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
               <span class="nx">production</span><span class="p">:</span> <span class="nx">Optional[bool]</span> = None<span class="p">,</span>
               <span class="nx">project_settings</span><span class="p">:</span> <span class="nx">Optional[DeploymentProjectSettingsArgs]</span> = None<span class="p">,</span>
               <span class="nx">ref</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">,</span>
               <span class="nx">team_id</span><span class="p">:</span> <span class="nx">Optional[str]</span> = None<span class="p">)</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="go">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-go" data-lang="go"><span class="k">func </span><span class="nx">NewDeployment</span><span class="p">(</span><span class="nx">ctx</span><span class="p"> *</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span><span class="p">,</span> <span class="nx">name</span><span class="p"> </span><span class="nx">string</span><span class="p">,</span> <span class="nx">args</span><span class="p"> </span><span class="nx"><a href="#inputs">DeploymentArgs</a></span><span class="p">,</span> <span class="nx">opts</span><span class="p"> ...</span><span class="nx"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span><span class="p">) (*<span class="nx">Deployment</span>, error)</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="csharp">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-csharp" data-lang="csharp"><span class="k">public </span><span class="nx">Deployment</span><span class="p">(</span><span class="nx">string</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">DeploymentArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span><span class="p">? </span><span class="nx">opts = null<span class="p">)</span></code></pre></div>
</div></pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="java">
<div class="no-copy"><div class="highlight"><pre class="chroma">
<code class="language-java" data-lang="java"><span class="k">public </span><span class="nx">Deployment</span><span class="p">(</span><span class="nx">String</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">DeploymentArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">)</span>
<span class="k">public </span><span class="nx">Deployment</span><span class="p">(</span><span class="nx">String</span><span class="p"> </span><span class="nx">name<span class="p">,</span> <span class="nx"><a href="#inputs">DeploymentArgs</a></span><span class="p"> </span><span class="nx">args<span class="p">,</span> <span class="nx">CustomResourceOptions</span><span class="p"> </span><span class="nx">options<span class="p">)</span>
</code></pre></div></div>
</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="yaml">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">type: <span class="nx">vercel:Deployment</span><span class="p"></span>
<span class="p">properties</span><span class="p">: </span><span class="c">#&nbsp;The arguments to resource properties.</span>
<span class="p"></span><span class="p">options</span><span class="p">: </span><span class="c">#&nbsp;Bag of options to control resource&#39;s behavior.</span>
<span class="p"></span>
</code></pre></div></div>
</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="hcl">
<div class="no-copy"><div class="highlight"><pre class="chroma"><code class="language-hcl" data-lang="hcl"><span class="k">resource</span> <span class="s2">&#34;vercel_deployment&#34;</span> <span class="s2">&#34;name&#34;</span> <span class="p">{</span>
<span class="c">    # resource properties</span>
<span class="p">}</span></code></pre></div></div>
</pulumi-choosable>
</div>

#### Parameters

<div>
<pulumi-choosable type="language" values="javascript,typescript">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">string</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">DeploymentArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="/docs/reference/pkg/nodejs/pulumi/pulumi/#CustomResourceOptions">CustomResourceOptions</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="python">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>resource_name</span>
        <span class="property-indicator"></span>
        <span class="property-type">str</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">DeploymentArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="/docs/reference/pkg/python/pulumi/#pulumi.ResourceOptions">ResourceOptions</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="go">

<dl class="resources-properties"><dt
        class="property-optional" title="Optional">
        <span>ctx</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#Context">Context</a></span>
    </dt>
    <dd>Context object for the current deployment.</dd><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">string</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">DeploymentArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="https://pkg.go.dev/github.com/pulumi/pulumi/sdk/v3/go/pulumi?tab=doc#ResourceOption">ResourceOption</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="csharp">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">string</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">DeploymentArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>opts</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="/docs/reference/pkg/dotnet/Pulumi/Pulumi.CustomResourceOptions.html">CustomResourceOptions</a></span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>

<div>
<pulumi-choosable type="language" values="java">

<dl class="resources-properties"><dt
        class="property-required" title="Required">
        <span>name</span>
        <span class="property-indicator"></span>
        <span class="property-type">String</span>
    </dt>
    <dd>The unique name of the resource.</dd><dt
        class="property-required" title="Required">
        <span>args</span>
        <span class="property-indicator"></span>
        <span class="property-type"><a href="#inputs">DeploymentArgs</a></span>
    </dt>
    <dd>The arguments to resource properties.</dd><dt
        class="property-optional" title="Optional">
        <span>options</span>
        <span class="property-indicator"></span>
        <span class="property-type">CustomResourceOptions</span>
    </dt>
    <dd>Bag of options to control resource&#39;s behavior.</dd></dl>

</pulumi-choosable>
</div>



### Constructor example

The following reference example uses placeholder values for all [input properties](#inputs).
<div>
<pulumi-chooser type="language" options="csharp,go,typescript,python,yaml,java,hcl"></pulumi-chooser>
</div>


<div>
<pulumi-choosable type="language" values="csharp">

```csharp
var deploymentResource = new Vercel.Deployment("deploymentResource", new()
{
    ProjectId = "string",
    CustomEnvironmentId = "string",
    DeleteOnDestroy = false,
    Environment = 
    {
        { "string", "string" },
    },
    Files = 
    {
        { "string", "string" },
    },
    Meta = 
    {
        { "string", "string" },
    },
    PathPrefix = "string",
    Production = false,
    ProjectSettings = new Vercel.Inputs.DeploymentProjectSettingsArgs
    {
        BuildCommand = "string",
        Framework = "string",
        InstallCommand = "string",
        OutputDirectory = "string",
        RootDirectory = "string",
    },
    Ref = "string",
    TeamId = "string",
});

ProjectId string

The project ID to add the deployment to.

CustomEnvironmentId string

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

DeleteOnDestroy bool

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

Environment Dictionary<string, string>

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

Files Dictionary<string, string>

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

Meta Dictionary<string, string>

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

PathPrefix string

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

Production bool

true if the deployment is a production deployment, meaning production aliases will be assigned.

ProjectSettings Pulumiverse.Vercel.Inputs.DeploymentProjectSettings

Project settings that will be applied to the deployment.

Ref string

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

TeamId string

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

ProjectId string

The project ID to add the deployment to.

CustomEnvironmentId string

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

DeleteOnDestroy bool

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

Environment map[string]string

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

Files map[string]string

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

Meta map[string]string

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

PathPrefix string

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

Production bool

true if the deployment is a production deployment, meaning production aliases will be assigned.

ProjectSettings DeploymentProjectSettingsArgs

Project settings that will be applied to the deployment.

Ref string

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

TeamId string

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

project_id string

The project ID to add the deployment to.

custom_environment_id string

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

delete_on_destroy bool

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

environment map(string)

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

files map(string)

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

meta map(string)

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

path_prefix string

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

production bool

true if the deployment is a production deployment, meaning production aliases will be assigned.

project_settings object

Project settings that will be applied to the deployment.

ref string

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

team_id string

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

projectId String

The project ID to add the deployment to.

customEnvironmentId String

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

deleteOnDestroy Boolean

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

environment Map<String,String>

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

files Map<String,String>

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

meta Map<String,String>

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

pathPrefix String

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

production Boolean

true if the deployment is a production deployment, meaning production aliases will be assigned.

projectSettings DeploymentProjectSettings

Project settings that will be applied to the deployment.

ref String

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

teamId String

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

projectId string

The project ID to add the deployment to.

customEnvironmentId string

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

deleteOnDestroy boolean

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

environment {[key: string]: string}

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

files {[key: string]: string}

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

meta {[key: string]: string}

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

pathPrefix string

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

production boolean

true if the deployment is a production deployment, meaning production aliases will be assigned.

projectSettings DeploymentProjectSettings

Project settings that will be applied to the deployment.

ref string

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

teamId string

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

project_id str

The project ID to add the deployment to.

custom_environment_id str

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

delete_on_destroy bool

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

environment Mapping[str, str]

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

files Mapping[str, str]

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

meta Mapping[str, str]

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

path_prefix str

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

production bool

true if the deployment is a production deployment, meaning production aliases will be assigned.

project_settings DeploymentProjectSettingsArgs

Project settings that will be applied to the deployment.

ref str

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

team_id str

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

projectId String

The project ID to add the deployment to.

customEnvironmentId String

The ID of the Custom Environment to deploy to. If not specified, the deployment will use the standard environments (production/preview).

deleteOnDestroy Boolean

Set to true to hard delete the Vercel deployment when destroying the Terraform resource. If unspecified, deployments are retained indefinitely. Note that deleted deployments are not recoverable.

environment Map<String>

A map of environment variable names to values. These are specific to a Deployment, and can also be configured on the vercel.Project resource.

files Map<String>

A map of files to be uploaded for the deployment. This should be provided by a vercel.getProjectDirectory or vercel.getFile data source. Required if git_source is not set.

meta Map<String>

Arbitrary key/value metadata to attach to the deployment (equivalent to the Vercel CLI --meta flags).

pathPrefix String

If specified then the path_prefix will be stripped from the start of file paths as they are uploaded to Vercel. If this is omitted, then any leading ../s will be stripped.

production Boolean

true if the deployment is a production deployment, meaning production aliases will be assigned.

projectSettings Property Map

Project settings that will be applied to the deployment.

ref String

The branch or commit hash that should be deployed. Note this will only work if the project is configured to use a Git repository. Required if files is not set.

teamId String

The team ID to add the deployment to. Required when configuring a team resource if a default team has not been set in the provider.

Domains List<string>

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

Id string

The provider-assigned unique ID for this managed resource.

Url string

A unique URL that is automatically generated for a deployment.

Domains []string

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

Id string

The provider-assigned unique ID for this managed resource.

Url string

A unique URL that is automatically generated for a deployment.

domains list(string)

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

id string

The provider-assigned unique ID for this managed resource.

url string

A unique URL that is automatically generated for a deployment.

domains List<String>

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

id String

The provider-assigned unique ID for this managed resource.

url String

A unique URL that is automatically generated for a deployment.

domains string[]

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

id string

The provider-assigned unique ID for this managed resource.

url string

A unique URL that is automatically generated for a deployment.

domains Sequence[str]

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

id str

The provider-assigned unique ID for this managed resource.

url str

A unique URL that is automatically generated for a deployment.

domains List<String>

A list of all the domains (default domains, staging domains and production domains) that were assigned upon deployment creation.

id String

The provider-assigned unique ID for this managed resource.

url String

A unique URL that is automatically generated for a deployment.

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.

BuildCommand string

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

Framework string

The framework that is being used for this deployment. If omitted, no framework is selected.

InstallCommand string

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

OutputDirectory string

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

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.

BuildCommand string

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

Framework string

The framework that is being used for this deployment. If omitted, no framework is selected.

InstallCommand string

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

OutputDirectory string

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

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.

build_command string

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

framework string

The framework that is being used for this deployment. If omitted, no framework is selected.

install_command string

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

output_directory string

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

root_directory 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.

buildCommand String

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

framework String

The framework that is being used for this deployment. If omitted, no framework is selected.

installCommand String

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

outputDirectory String

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

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.

buildCommand string

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

framework string

The framework that is being used for this deployment. If omitted, no framework is selected.

installCommand string

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

outputDirectory string

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

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.

build_command str

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

framework str

The framework that is being used for this deployment. If omitted, no framework is selected.

install_command str

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

output_directory str

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

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.

buildCommand String

The build command for this deployment. If omitted, this value will be taken from the project or automatically detected.

framework String

The framework that is being used for this deployment. If omitted, no framework is selected.

installCommand String

The install command for this deployment. If omitted, this value will be taken from the project or automatically detected.

outputDirectory String

The output directory of the deployment. If omitted, this value will be taken from the project or automatically detected.

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.