Skip to main content

getOrCreateBucket()

Creates a bucket for Remotion Lambda in your S3 account. If one already exists, it will get returned instead.

Only 1 bucket per region is necessary for Remotion Lambda to function.

ts
import { getOrCreateBucket } from "@remotion/lambda";
 
const { bucketName } = await getOrCreateBucket({ region: "us-east-1" });
 
console.log(bucketName); // "remotionlambda-32df3p"
ts
import { getOrCreateBucket } from "@remotion/lambda";
 
const { bucketName } = await getOrCreateBucket({ region: "us-east-1" });
 
console.log(bucketName); // "remotionlambda-32df3p"

Arguments​

An object with the following property:

region​

The AWS region which you want to create a bucket in.

enableFolderExpiryv4.0.32​

When deploying sites, enable or disable S3 Lifecycle policies which allow for renders to auto-delete after a certain time. Default is null, which does not change any lifecycle policies of the S3 bucket. See: Lambda autodelete.

onBucketEnsured?​

removed in v4.0, optional

Allows to pass a callback after the bucket was created and before the S3 website option was enabled. This option exists so the CLI can better visualize the progress.
Removed in v4.0 since we don't use the website option anymore.

forcePathStyle?v4.0.202​

Passes forcePathStyle to the AWS S3 client. If you don't know what this is, you probably don't need it.

Return value​

A promise resolving to an object with the following properties:

bucketName​

The name of your bucket that was found or created.

alreadyExistedv3.3.78​

A boolean indicating whether the bucket already existed or was newly created.

See also​