1. Packages
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. VcrRepository
Viewing docs for Vercel v5.4.1
published on Wednesday, Jul 22, 2026 by Pulumiverse
vercel logo
Viewing docs for Vercel v5.4.1
published on Wednesday, Jul 22, 2026 by Pulumiverse

    Provides a Vercel Container Registry (VCR) Repository resource.

    A VCR Repository belongs to a Vercel Project and stores container images that can be used by Vercel Functions and Vercel Sandbox. Images are pushed to and pulled from vcr.vercel.com/team-slug/project-slug/repository-name using Docker-compatible tooling.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumiverse/vercel";
    
    const example = new vercel.Project("example", {name: "example-project-with-vcr-repository"});
    const exampleVcrRepository = new vercel.VcrRepository("example", {
        projectId: example.id,
        name: "my-repository",
    });
    
    import pulumi
    import pulumiverse_vercel as vercel
    
    example = vercel.Project("example", name="example-project-with-vcr-repository")
    example_vcr_repository = vercel.VcrRepository("example",
        project_id=example.id,
        name="my-repository")
    
    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-with-vcr-repository"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vercel.NewVcrRepository(ctx, "example", &vercel.VcrRepositoryArgs{
    			ProjectId: example.ID(),
    			Name:      pulumi.String("my-repository"),
    		})
    		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-with-vcr-repository",
        });
    
        var exampleVcrRepository = new Vercel.VcrRepository("example", new()
        {
            ProjectId = example.Id,
            Name = "my-repository",
        });
    
    });
    
    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.VcrRepository;
    import com.pulumiverse.vercel.VcrRepositoryArgs;
    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-with-vcr-repository")
                .build());
    
            var exampleVcrRepository = new VcrRepository("exampleVcrRepository", VcrRepositoryArgs.builder()
                .projectId(example.id())
                .name("my-repository")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vercel:Project
        properties:
          name: example-project-with-vcr-repository
      exampleVcrRepository:
        type: vercel:VcrRepository
        name: example
        properties:
          projectId: ${example.id}
          name: my-repository
    
    Example coming soon!
    

    Create VcrRepository Resource

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

    Constructor syntax

    new VcrRepository(name: string, args: VcrRepositoryArgs, opts?: CustomResourceOptions);
    @overload
    def VcrRepository(resource_name: str,
                      args: VcrRepositoryArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def VcrRepository(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      project_id: Optional[str] = None,
                      name: Optional[str] = None,
                      team_id: Optional[str] = None)
    func NewVcrRepository(ctx *Context, name string, args VcrRepositoryArgs, opts ...ResourceOption) (*VcrRepository, error)
    public VcrRepository(string name, VcrRepositoryArgs args, CustomResourceOptions? opts = null)
    public VcrRepository(String name, VcrRepositoryArgs args)
    public VcrRepository(String name, VcrRepositoryArgs args, CustomResourceOptions options)
    
    type: vercel:VcrRepository
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "vercel_vcr_repository" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args VcrRepositoryArgs
    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 VcrRepositoryArgs
    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 VcrRepositoryArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VcrRepositoryArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VcrRepositoryArgs
    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 vcrRepositoryResource = new Vercel.VcrRepository("vcrRepositoryResource", new()
    {
        ProjectId = "string",
        Name = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewVcrRepository(ctx, "vcrRepositoryResource", &vercel.VcrRepositoryArgs{
    	ProjectId: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	TeamId:    pulumi.String("string"),
    })
    
    resource "vercel_vcr_repository" "vcrRepositoryResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id = "string"
      name       = "string"
      team_id    = "string"
    }
    
    var vcrRepositoryResource = new VcrRepository("vcrRepositoryResource", VcrRepositoryArgs.builder()
        .projectId("string")
        .name("string")
        .teamId("string")
        .build());
    
    vcr_repository_resource = vercel.VcrRepository("vcrRepositoryResource",
        project_id="string",
        name="string",
        team_id="string")
    
    const vcrRepositoryResource = new vercel.VcrRepository("vcrRepositoryResource", {
        projectId: "string",
        name: "string",
        teamId: "string",
    });
    
    type: vercel:VcrRepository
    properties:
        name: string
        projectId: string
        teamId: string
    

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

    ProjectId string
    The ID of the existing Vercel Project the repository belongs to.
    Name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    TeamId string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    ProjectId string
    The ID of the existing Vercel Project the repository belongs to.
    Name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    TeamId string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    project_id string
    The ID of the existing Vercel Project the repository belongs to.
    name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    team_id string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    projectId String
    The ID of the existing Vercel Project the repository belongs to.
    name String
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    teamId String
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    projectId string
    The ID of the existing Vercel Project the repository belongs to.
    name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    teamId string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    project_id str
    The ID of the existing Vercel Project the repository belongs to.
    name str
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    team_id str
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    projectId String
    The ID of the existing Vercel Project the repository belongs to.
    name String
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    teamId String
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    Id string
    The provider-assigned unique ID for this managed resource.
    Url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    id string
    The provider-assigned unique ID for this managed resource.
    url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    id str
    The provider-assigned unique ID for this managed resource.
    url str
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    id String
    The provider-assigned unique ID for this managed resource.
    url String
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.

    Look up Existing VcrRepository Resource

    Get an existing VcrRepository 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?: VcrRepositoryState, opts?: CustomResourceOptions): VcrRepository
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            team_id: Optional[str] = None,
            url: Optional[str] = None) -> VcrRepository
    func GetVcrRepository(ctx *Context, name string, id IDInput, state *VcrRepositoryState, opts ...ResourceOption) (*VcrRepository, error)
    public static VcrRepository Get(string name, Input<string> id, VcrRepositoryState? state, CustomResourceOptions? opts = null)
    public static VcrRepository get(String name, Output<String> id, VcrRepositoryState state, CustomResourceOptions options)
    resources:  _:    type: vercel:VcrRepository    get:      id: ${id}
    import {
      to = vercel_vcr_repository.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:
    Name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    ProjectId string
    The ID of the existing Vercel Project the repository belongs to.
    TeamId string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    Url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    Name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    ProjectId string
    The ID of the existing Vercel Project the repository belongs to.
    TeamId string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    Url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    project_id string
    The ID of the existing Vercel Project the repository belongs to.
    team_id string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    name String
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    projectId String
    The ID of the existing Vercel Project the repository belongs to.
    teamId String
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    url String
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    name string
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    projectId string
    The ID of the existing Vercel Project the repository belongs to.
    teamId string
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    url string
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    name str
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    project_id str
    The ID of the existing Vercel Project the repository belongs to.
    team_id str
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    url str
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.
    name String
    The name of the repository. Can contain lowercase letters, numbers, periods, underscores, and dashes, but cannot start or end with a period, underscore, or dash.
    projectId String
    The ID of the existing Vercel Project the repository belongs to.
    teamId String
    The ID of the team the repository should be created under. Required when configuring a team resource if a default team has not been set in the provider.
    url String
    The URL of the repository, composed of the owner slug, the project slug and the repository name (e.g. vcr.vercel.com/team-slug/project-slug/repository-name). Use it to push and pull images with Docker-compatible tooling.

    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 repository name.

    • project_id can be found in the project settings tab in the Vercel UI.
    $ pulumi import vercel:index/vcrRepository:VcrRepository example prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/my-repository
    

    Alternatively, you can import via the team_id, project_id and repository 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/vcrRepository:VcrRepository example team_xxxxxxxxxxxxxxxxxxxxxxxx/prj_xxxxxxxxxxxxxxxxxxxxxxxxxxxx/my-repository
    

    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
    Viewing docs for Vercel v5.4.1
    published on Wednesday, Jul 22, 2026 by Pulumiverse

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial