1. Packages
  2. Packages
  3. Vercel Provider
  4. API Docs
  5. BlobStore
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 Blob store.

    Blob stores are team-scoped storage resources that back Vercel Blob uploads and can be connected to one or more projects.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumiverse/vercel";
    
    const example = new vercel.BlobStore("example", {
        name: "example-blob-store",
        access: "private",
        region: "iad1",
    });
    
    import pulumi
    import pulumiverse_vercel as vercel
    
    example = vercel.BlobStore("example",
        name="example-blob-store",
        access="private",
        region="iad1")
    
    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 {
    		_, err := vercel.NewBlobStore(ctx, "example", &vercel.BlobStoreArgs{
    			Name:   pulumi.String("example-blob-store"),
    			Access: pulumi.String("private"),
    			Region: pulumi.String("iad1"),
    		})
    		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",
            Access = "private",
            Region = "iad1",
        });
    
    });
    
    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 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")
                .access("private")
                .region("iad1")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vercel:BlobStore
        properties:
          name: example-blob-store
          access: private
          region: iad1
    
    Example coming soon!
    

    Create BlobStore Resource

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

    Constructor syntax

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

    Parameters

    name string
    The unique name of the resource.
    args BlobStoreArgs
    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 BlobStoreArgs
    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 BlobStoreArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BlobStoreArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BlobStoreArgs
    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 blobStoreResource = new Vercel.BlobStore("blobStoreResource", new()
    {
        Access = "string",
        Name = "string",
        Region = "string",
        TeamId = "string",
    });
    
    example, err := vercel.NewBlobStore(ctx, "blobStoreResource", &vercel.BlobStoreArgs{
    	Access: pulumi.String("string"),
    	Name:   pulumi.String("string"),
    	Region: pulumi.String("string"),
    	TeamId: pulumi.String("string"),
    })
    
    resource "vercel_blob_store" "blobStoreResource" {
      lifecycle {
        create_before_destroy = true
      }
      access  = "string"
      name    = "string"
      region  = "string"
      team_id = "string"
    }
    
    var blobStoreResource = new BlobStore("blobStoreResource", BlobStoreArgs.builder()
        .access("string")
        .name("string")
        .region("string")
        .teamId("string")
        .build());
    
    blob_store_resource = vercel.BlobStore("blobStoreResource",
        access="string",
        name="string",
        region="string",
        team_id="string")
    
    const blobStoreResource = new vercel.BlobStore("blobStoreResource", {
        access: "string",
        name: "string",
        region: "string",
        teamId: "string",
    });
    
    type: vercel:BlobStore
    properties:
        access: string
        name: string
        region: string
        teamId: string
    

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

    Access string
    Whether blobs should be created with public or private access.
    Name string
    The name of the Blob store.
    Region string
    The region in which the Blob store should be created.
    TeamId string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Access string
    Whether blobs should be created with public or private access.
    Name string
    The name of the Blob store.
    Region string
    The region in which the Blob store should be created.
    TeamId string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access string
    Whether blobs should be created with public or private access.
    name string
    The name of the Blob store.
    region string
    The region in which the Blob store should be created.
    team_id string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access String
    Whether blobs should be created with public or private access.
    name String
    The name of the Blob store.
    region String
    The region in which the Blob store should be created.
    teamId String
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access string
    Whether blobs should be created with public or private access.
    name string
    The name of the Blob store.
    region string
    The region in which the Blob store should be created.
    teamId string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access str
    Whether blobs should be created with public or private access.
    name str
    The name of the Blob store.
    region str
    The region in which the Blob store should be created.
    team_id str
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    access String
    Whether blobs should be created with public or private access.
    name String
    The name of the Blob store.
    region String
    The region in which the Blob store should be created.
    teamId String
    The ID of the team the Blob store should exist 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 BlobStore resource produces the following output properties:

    CreatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was created.
    FileCount int
    The number of files currently stored in the Blob store.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size int
    The size of the Blob store in bytes.
    Status string
    The current status of the Blob store.
    UpdatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    CreatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was created.
    FileCount int
    The number of files currently stored in the Blob store.
    Id string
    The provider-assigned unique ID for this managed resource.
    Size int
    The size of the Blob store in bytes.
    Status string
    The current status of the Blob store.
    UpdatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    created_at number
    The Unix timestamp, in milliseconds, when the Blob store was created.
    file_count number
    The number of files currently stored in the Blob store.
    id string
    The provider-assigned unique ID for this managed resource.
    size number
    The size of the Blob store in bytes.
    status string
    The current status of the Blob store.
    updated_at number
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    createdAt Integer
    The Unix timestamp, in milliseconds, when the Blob store was created.
    fileCount Integer
    The number of files currently stored in the Blob store.
    id String
    The provider-assigned unique ID for this managed resource.
    size Integer
    The size of the Blob store in bytes.
    status String
    The current status of the Blob store.
    updatedAt Integer
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    createdAt number
    The Unix timestamp, in milliseconds, when the Blob store was created.
    fileCount number
    The number of files currently stored in the Blob store.
    id string
    The provider-assigned unique ID for this managed resource.
    size number
    The size of the Blob store in bytes.
    status string
    The current status of the Blob store.
    updatedAt number
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    created_at int
    The Unix timestamp, in milliseconds, when the Blob store was created.
    file_count int
    The number of files currently stored in the Blob store.
    id str
    The provider-assigned unique ID for this managed resource.
    size int
    The size of the Blob store in bytes.
    status str
    The current status of the Blob store.
    updated_at int
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    createdAt Number
    The Unix timestamp, in milliseconds, when the Blob store was created.
    fileCount Number
    The number of files currently stored in the Blob store.
    id String
    The provider-assigned unique ID for this managed resource.
    size Number
    The size of the Blob store in bytes.
    status String
    The current status of the Blob store.
    updatedAt Number
    The Unix timestamp, in milliseconds, when the Blob store was last updated.

    Look up Existing BlobStore Resource

    Get an existing BlobStore 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?: BlobStoreState, opts?: CustomResourceOptions): BlobStore
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access: Optional[str] = None,
            created_at: Optional[int] = None,
            file_count: Optional[int] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            size: Optional[int] = None,
            status: Optional[str] = None,
            team_id: Optional[str] = None,
            updated_at: Optional[int] = None) -> BlobStore
    func GetBlobStore(ctx *Context, name string, id IDInput, state *BlobStoreState, opts ...ResourceOption) (*BlobStore, error)
    public static BlobStore Get(string name, Input<string> id, BlobStoreState? state, CustomResourceOptions? opts = null)
    public static BlobStore get(String name, Output<String> id, BlobStoreState state, CustomResourceOptions options)
    resources:  _:    type: vercel:BlobStore    get:      id: ${id}
    import {
      to = vercel_blob_store.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:
    Access string
    Whether blobs should be created with public or private access.
    CreatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was created.
    FileCount int
    The number of files currently stored in the Blob store.
    Name string
    The name of the Blob store.
    Region string
    The region in which the Blob store should be created.
    Size int
    The size of the Blob store in bytes.
    Status string
    The current status of the Blob store.
    TeamId string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    UpdatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    Access string
    Whether blobs should be created with public or private access.
    CreatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was created.
    FileCount int
    The number of files currently stored in the Blob store.
    Name string
    The name of the Blob store.
    Region string
    The region in which the Blob store should be created.
    Size int
    The size of the Blob store in bytes.
    Status string
    The current status of the Blob store.
    TeamId string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    UpdatedAt int
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    access string
    Whether blobs should be created with public or private access.
    created_at number
    The Unix timestamp, in milliseconds, when the Blob store was created.
    file_count number
    The number of files currently stored in the Blob store.
    name string
    The name of the Blob store.
    region string
    The region in which the Blob store should be created.
    size number
    The size of the Blob store in bytes.
    status string
    The current status of the Blob store.
    team_id string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    updated_at number
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    access String
    Whether blobs should be created with public or private access.
    createdAt Integer
    The Unix timestamp, in milliseconds, when the Blob store was created.
    fileCount Integer
    The number of files currently stored in the Blob store.
    name String
    The name of the Blob store.
    region String
    The region in which the Blob store should be created.
    size Integer
    The size of the Blob store in bytes.
    status String
    The current status of the Blob store.
    teamId String
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    updatedAt Integer
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    access string
    Whether blobs should be created with public or private access.
    createdAt number
    The Unix timestamp, in milliseconds, when the Blob store was created.
    fileCount number
    The number of files currently stored in the Blob store.
    name string
    The name of the Blob store.
    region string
    The region in which the Blob store should be created.
    size number
    The size of the Blob store in bytes.
    status string
    The current status of the Blob store.
    teamId string
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    updatedAt number
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    access str
    Whether blobs should be created with public or private access.
    created_at int
    The Unix timestamp, in milliseconds, when the Blob store was created.
    file_count int
    The number of files currently stored in the Blob store.
    name str
    The name of the Blob store.
    region str
    The region in which the Blob store should be created.
    size int
    The size of the Blob store in bytes.
    status str
    The current status of the Blob store.
    team_id str
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    updated_at int
    The Unix timestamp, in milliseconds, when the Blob store was last updated.
    access String
    Whether blobs should be created with public or private access.
    createdAt Number
    The Unix timestamp, in milliseconds, when the Blob store was created.
    fileCount Number
    The number of files currently stored in the Blob store.
    name String
    The name of the Blob store.
    region String
    The region in which the Blob store should be created.
    size Number
    The size of the Blob store in bytes.
    status String
    The current status of the Blob store.
    teamId String
    The ID of the team the Blob store should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    updatedAt Number
    The Unix timestamp, in milliseconds, when the Blob store was last updated.

    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 Blob store id.

    $ pulumi import vercel:index/blobStore:BlobStore example store_xxxxxxxxxxxxxxxxxx
    

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

    $ pulumi import vercel:index/blobStore:BlobStore example team_xxxxxxxxxxxxxxxxxxxxxxxx/store_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