Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vercel
  3. API Docs
  4. getDeployment
Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel

vercel.getDeployment

Explore with Pulumi AI

vercel logo
Vercel v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
pulumiverse/pulumi-vercel

    Provides information about an existing Deployment.

    A Deployment is the result of building your Project and making it available through a live URL.

    Example Usage

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

const example = vercel.getDeployment({
    id: "https://my-vercel-project.vercel.app",
});

    import pulumi
import pulumi_vercel as vercel

example = vercel.get_deployment(id="https://my-vercel-project.vercel.app")

    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 {
		_, err := vercel.LookupDeployment(ctx, &vercel.LookupDeploymentArgs{
			Id: "https://my-vercel-project.vercel.app",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Vercel.GetDeployment.Invoke(new()
    {
        Id = "https://my-vercel-project.vercel.app",
    });

});

    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.GetDeploymentArgs;
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 example = VercelFunctions.getDeployment(GetDeploymentArgs.builder()
            .id("https://my-vercel-project.vercel.app")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      Function: vercel:getDeployment
      Arguments:
        id: https://my-vercel-project.vercel.app

    Using getDeployment

    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 getDeployment(args: GetDeploymentArgs, opts?: InvokeOptions): Promise<GetDeploymentResult>
function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: InvokeOptions): Output<GetDeploymentResult>
    def get_deployment(id: Optional[str] = None,
                   team_id: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDeploymentResult
def get_deployment_output(id: Optional[pulumi.Input[str]] = None,
                   team_id: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentResult]
    func LookupDeployment(ctx *Context, args *LookupDeploymentArgs, opts ...InvokeOption) (*LookupDeploymentResult, error)
func LookupDeploymentOutput(ctx *Context, args *LookupDeploymentOutputArgs, opts ...InvokeOption) LookupDeploymentResultOutput

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

    public static class GetDeployment 
{
    public static Task<GetDeploymentResult> InvokeAsync(GetDeploymentArgs args, InvokeOptions? opts = null)
    public static Output<GetDeploymentResult> Invoke(GetDeploymentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDeploymentResult> getDeployment(GetDeploymentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    Id string
    The ID or URL of the Deployment to read.
    TeamId string
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    Id string
    The ID or URL of the Deployment to read.
    TeamId string
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    id String
    The ID or URL of the Deployment to read.
    teamId String
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    id string
    The ID or URL of the Deployment to read.
    teamId string
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    id str
    The ID or URL of the Deployment to read.
    team_id str
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    id String
    The ID or URL of the Deployment to read.
    teamId String
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.

    getDeployment Result

    The following output properties are available:

    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 ID or URL of the Deployment to read.
    Production bool
    true if the deployment is a production deployment, meaning production aliases will be assigned.
    ProjectId string
    The project ID to add the deployment to.
    Ref string
    The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
    TeamId string
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    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 ID or URL of the Deployment to read.
    Production bool
    true if the deployment is a production deployment, meaning production aliases will be assigned.
    ProjectId string
    The project ID to add the deployment to.
    Ref string
    The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
    TeamId string
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    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 ID or URL of the Deployment to read.
    production Boolean
    true if the deployment is a production deployment, meaning production aliases will be assigned.
    projectId String
    The project ID to add the deployment to.
    ref String
    The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
    teamId String
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    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 ID or URL of the Deployment to read.
    production boolean
    true if the deployment is a production deployment, meaning production aliases will be assigned.
    projectId string
    The project ID to add the deployment to.
    ref string
    The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
    teamId string
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    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 ID or URL of the Deployment to read.
    production bool
    true if the deployment is a production deployment, meaning production aliases will be assigned.
    project_id str
    The project ID to add the deployment to.
    ref str
    The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
    team_id str
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    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 ID or URL of the Deployment to read.
    production Boolean
    true if the deployment is a production deployment, meaning production aliases will be assigned.
    projectId String
    The project ID to add the deployment to.
    ref String
    The branch or commit hash that has been deployed. Note this will only work if the project is configured to use a Git repository.
    teamId String
    The Team ID to the Deployment belong to. Required when reading a team resource if a default team has not been set in the provider.
    url String
    A unique URL that is automatically generated for a deployment.

    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 v1.14.3 published on Monday, Oct 7, 2024 by Pulumiverse
    pulumiverse/pulumi-vercel