1. Packages
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. BlobProjectConnection
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 project connection for a Vercel Blob store.

    This resource links an existing Blob store to a project and manages the generated BLOB_READ_WRITE_TOKEN environment variable prefix and target environments.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumiverse/vercel";
    
    const example = new vercel.BlobStore("example", {name: "example-blob-store"});
    const exampleProject = new vercel.Project("example", {name: "example-blob-project"});
    const exampleBlobProjectConnection = new vercel.BlobProjectConnection("example", {
        blobStoreId: example.id,
        projectId: exampleProject.id,
        environments: [
            "preview",
            "production",
        ],
    });
    
    import pulumi
    import pulumiverse_vercel as vercel
    
    example = vercel.BlobStore("example", name="example-blob-store")
    example_project = vercel.Project("example", name="example-blob-project")
    example_blob_project_connection = vercel.BlobProjectConnection("example",
        blob_store_id=example.id,
        project_id=example_project.id,
        environments=[
            "preview",
            "production",
        ])
    
    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.NewBlobStore(ctx, "example", &vercel.BlobStoreArgs{
    			Name: pulumi.String("example-blob-store"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleProject, err := vercel.NewProject(ctx, "example", &vercel.ProjectArgs{
    			Name: pulumi.String("example-blob-project"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = vercel.NewBlobProjectConnection(ctx, "example", &vercel.BlobProjectConnectionArgs{
    			BlobStoreId: example.ID(),
    			ProjectId:   exampleProject.ID(),
    			Environments: pulumi.StringArray{
    				pulumi.String("preview"),
    				pulumi.String("production"),
    			},
    		})
    		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.BlobStore("example", new()
        {
            Name = "example-blob-store",
        });
    
        var exampleProject = new Vercel.Project("example", new()
        {
            Name = "example-blob-project",
        });
    
        var exampleBlobProjectConnection = new Vercel.BlobProjectConnection("example", new()
        {
            BlobStoreId = example.Id,
            ProjectId = exampleProject.Id,
            Environments = new[]
            {
                "preview",
                "production",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumiverse.vercel.BlobStore;
    import com.pulumiverse.vercel.BlobStoreArgs;
    import com.pulumiverse.vercel.Project;
    import com.pulumiverse.vercel.ProjectArgs;
    import com.pulumiverse.vercel.BlobProjectConnection;
    import com.pulumiverse.vercel.BlobProjectConnectionArgs;
    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 BlobStore("example", BlobStoreArgs.builder()
                .name("example-blob-store")
                .build());
    
            var exampleProject = new Project("exampleProject", ProjectArgs.builder()
                .name("example-blob-project")
                .build());
    
            var exampleBlobProjectConnection = new BlobProjectConnection("exampleBlobProjectConnection", BlobProjectConnectionArgs.builder()
                .blobStoreId(example.id())
                .projectId(exampleProject.id())
                .environments(            
                    "preview",
                    "production")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vercel:BlobStore
        properties:
          name: example-blob-store
      exampleProject:
        type: vercel:Project
        name: example
        properties:
          name: example-blob-project
      exampleBlobProjectConnection:
        type: vercel:BlobProjectConnection
        name: example
        properties:
          blobStoreId: ${example.id}
          projectId: ${exampleProject.id}
          environments:
            - preview
            - production
    
    Example coming soon!
    

    Create BlobProjectConnection Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args BlobProjectConnectionArgs
    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 BlobProjectConnectionArgs
    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 BlobProjectConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BlobProjectConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BlobProjectConnectionArgs
    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 blobProjectConnectionResource = new Vercel.BlobProjectConnection("blobProjectConnectionResource", new()
    {
        BlobStoreId = "string",
        ProjectId = "string",
        EnvVarPrefix = "string",
        Environments = new[]
        {
            "string",
        },
        TeamId = "string",
    });
    
    example, err := vercel.NewBlobProjectConnection(ctx, "blobProjectConnectionResource", &vercel.BlobProjectConnectionArgs{
    	BlobStoreId:  pulumi.String("string"),
    	ProjectId:    pulumi.String("string"),
    	EnvVarPrefix: pulumi.String("string"),
    	Environments: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TeamId: pulumi.String("string"),
    })
    
    resource "vercel_blob_project_connection" "blobProjectConnectionResource" {
      lifecycle {
        create_before_destroy = true
      }
      blob_store_id  = "string"
      project_id     = "string"
      env_var_prefix = "string"
      environments   = ["string"]
      team_id        = "string"
    }
    
    var blobProjectConnectionResource = new BlobProjectConnection("blobProjectConnectionResource", BlobProjectConnectionArgs.builder()
        .blobStoreId("string")
        .projectId("string")
        .envVarPrefix("string")
        .environments("string")
        .teamId("string")
        .build());
    
    blob_project_connection_resource = vercel.BlobProjectConnection("blobProjectConnectionResource",
        blob_store_id="string",
        project_id="string",
        env_var_prefix="string",
        environments=["string"],
        team_id="string")
    
    const blobProjectConnectionResource = new vercel.BlobProjectConnection("blobProjectConnectionResource", {
        blobStoreId: "string",
        projectId: "string",
        envVarPrefix: "string",
        environments: ["string"],
        teamId: "string",
    });
    
    type: vercel:BlobProjectConnection
    properties:
        blobStoreId: string
        envVarPrefix: string
        environments:
            - string
        projectId: string
        teamId: string
    

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

    BlobStoreId string
    The ID of the Blob store to connect.
    ProjectId string
    The ID of the Vercel project to connect to the Blob store.
    EnvVarPrefix string
    The prefix used for the generated Blob environment variable names.
    Environments List<string>
    The environments in which the generated Blob environment variables should be created.
    TeamId string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    BlobStoreId string
    The ID of the Blob store to connect.
    ProjectId string
    The ID of the Vercel project to connect to the Blob store.
    EnvVarPrefix string
    The prefix used for the generated Blob environment variable names.
    Environments []string
    The environments in which the generated Blob environment variables should be created.
    TeamId string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blob_store_id string
    The ID of the Blob store to connect.
    project_id string
    The ID of the Vercel project to connect to the Blob store.
    env_var_prefix string
    The prefix used for the generated Blob environment variable names.
    environments list(string)
    The environments in which the generated Blob environment variables should be created.
    team_id string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blobStoreId String
    The ID of the Blob store to connect.
    projectId String
    The ID of the Vercel project to connect to the Blob store.
    envVarPrefix String
    The prefix used for the generated Blob environment variable names.
    environments List<String>
    The environments in which the generated Blob environment variables should be created.
    teamId String
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blobStoreId string
    The ID of the Blob store to connect.
    projectId string
    The ID of the Vercel project to connect to the Blob store.
    envVarPrefix string
    The prefix used for the generated Blob environment variable names.
    environments string[]
    The environments in which the generated Blob environment variables should be created.
    teamId string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blob_store_id str
    The ID of the Blob store to connect.
    project_id str
    The ID of the Vercel project to connect to the Blob store.
    env_var_prefix str
    The prefix used for the generated Blob environment variable names.
    environments Sequence[str]
    The environments in which the generated Blob environment variables should be created.
    team_id str
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blobStoreId String
    The ID of the Blob store to connect.
    projectId String
    The ID of the Vercel project to connect to the Blob store.
    envVarPrefix String
    The prefix used for the generated Blob environment variable names.
    environments List<String>
    The environments in which the generated Blob environment variables should be created.
    teamId String
    The ID of the team that owns the Blob store and project. 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 BlobProjectConnection resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    ReadWriteTokenEnvVarName string
    The generated environment variable name that contains the Blob read/write token.
    Id string
    The provider-assigned unique ID for this managed resource.
    ReadWriteTokenEnvVarName string
    The generated environment variable name that contains the Blob read/write token.
    id string
    The provider-assigned unique ID for this managed resource.
    read_write_token_env_var_name string
    The generated environment variable name that contains the Blob read/write token.
    id String
    The provider-assigned unique ID for this managed resource.
    readWriteTokenEnvVarName String
    The generated environment variable name that contains the Blob read/write token.
    id string
    The provider-assigned unique ID for this managed resource.
    readWriteTokenEnvVarName string
    The generated environment variable name that contains the Blob read/write token.
    id str
    The provider-assigned unique ID for this managed resource.
    read_write_token_env_var_name str
    The generated environment variable name that contains the Blob read/write token.
    id String
    The provider-assigned unique ID for this managed resource.
    readWriteTokenEnvVarName String
    The generated environment variable name that contains the Blob read/write token.

    Look up Existing BlobProjectConnection Resource

    Get an existing BlobProjectConnection 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?: BlobProjectConnectionState, opts?: CustomResourceOptions): BlobProjectConnection
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            blob_store_id: Optional[str] = None,
            env_var_prefix: Optional[str] = None,
            environments: Optional[Sequence[str]] = None,
            project_id: Optional[str] = None,
            read_write_token_env_var_name: Optional[str] = None,
            team_id: Optional[str] = None) -> BlobProjectConnection
    func GetBlobProjectConnection(ctx *Context, name string, id IDInput, state *BlobProjectConnectionState, opts ...ResourceOption) (*BlobProjectConnection, error)
    public static BlobProjectConnection Get(string name, Input<string> id, BlobProjectConnectionState? state, CustomResourceOptions? opts = null)
    public static BlobProjectConnection get(String name, Output<String> id, BlobProjectConnectionState state, CustomResourceOptions options)
    resources:  _:    type: vercel:BlobProjectConnection    get:      id: ${id}
    import {
      to = vercel_blob_project_connection.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:
    BlobStoreId string
    The ID of the Blob store to connect.
    EnvVarPrefix string
    The prefix used for the generated Blob environment variable names.
    Environments List<string>
    The environments in which the generated Blob environment variables should be created.
    ProjectId string
    The ID of the Vercel project to connect to the Blob store.
    ReadWriteTokenEnvVarName string
    The generated environment variable name that contains the Blob read/write token.
    TeamId string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    BlobStoreId string
    The ID of the Blob store to connect.
    EnvVarPrefix string
    The prefix used for the generated Blob environment variable names.
    Environments []string
    The environments in which the generated Blob environment variables should be created.
    ProjectId string
    The ID of the Vercel project to connect to the Blob store.
    ReadWriteTokenEnvVarName string
    The generated environment variable name that contains the Blob read/write token.
    TeamId string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blob_store_id string
    The ID of the Blob store to connect.
    env_var_prefix string
    The prefix used for the generated Blob environment variable names.
    environments list(string)
    The environments in which the generated Blob environment variables should be created.
    project_id string
    The ID of the Vercel project to connect to the Blob store.
    read_write_token_env_var_name string
    The generated environment variable name that contains the Blob read/write token.
    team_id string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blobStoreId String
    The ID of the Blob store to connect.
    envVarPrefix String
    The prefix used for the generated Blob environment variable names.
    environments List<String>
    The environments in which the generated Blob environment variables should be created.
    projectId String
    The ID of the Vercel project to connect to the Blob store.
    readWriteTokenEnvVarName String
    The generated environment variable name that contains the Blob read/write token.
    teamId String
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blobStoreId string
    The ID of the Blob store to connect.
    envVarPrefix string
    The prefix used for the generated Blob environment variable names.
    environments string[]
    The environments in which the generated Blob environment variables should be created.
    projectId string
    The ID of the Vercel project to connect to the Blob store.
    readWriteTokenEnvVarName string
    The generated environment variable name that contains the Blob read/write token.
    teamId string
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blob_store_id str
    The ID of the Blob store to connect.
    env_var_prefix str
    The prefix used for the generated Blob environment variable names.
    environments Sequence[str]
    The environments in which the generated Blob environment variables should be created.
    project_id str
    The ID of the Vercel project to connect to the Blob store.
    read_write_token_env_var_name str
    The generated environment variable name that contains the Blob read/write token.
    team_id str
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.
    blobStoreId String
    The ID of the Blob store to connect.
    envVarPrefix String
    The prefix used for the generated Blob environment variable names.
    environments List<String>
    The environments in which the generated Blob environment variables should be created.
    projectId String
    The ID of the Vercel project to connect to the Blob store.
    readWriteTokenEnvVarName String
    The generated environment variable name that contains the Blob read/write token.
    teamId String
    The ID of the team that owns the Blob store and project. Required when configuring a team resource if a default team has not been set in the provider.

    Import

    The pulumi import command can be used, for example:

    If importing into a personal account, or with a team configured on the provider, use the Blob store id and connection id.

    $ pulumi import vercel:index/blobProjectConnection:BlobProjectConnection example store_xxxxxxxxxxxxxxxxxx/spc_xxxxxxxxxxxxxxxxxx
    

    Alternatively, you can import via the team_id, Blob store id, and connection id.

    $ pulumi import vercel:index/blobProjectConnection:BlobProjectConnection example team_xxxxxxxxxxxxxxxxxxxxxxxx/store_xxxxxxxxxxxxxxxxxx/spc_xxxxxxxxxxxxxxxxxx
    

    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