packages/docs/docs/lambda/getorcreatebucket.mdx
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.
import {getOrCreateBucket} from '@remotion/lambda';
const {bucketName} = await getOrCreateBucket({region: 'us-east-1'});
console.log(bucketName); // "remotionlambda-32df3p"
An object with the following property:
regionThe AWS region which you want to create a bucket in.
enableFolderExpiry<AvailableFrom v="4.0.32" />onBucketEnsuredremoved in v4.0
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?<AvailableFrom v="4.0.202" />Passes forcePathStyle to the AWS S3 client. If you don't know what this is, you probably don't need it.
A promise resolving to an object with the following properties:
bucketNameThe name of your bucket that was found or created.
alreadyExisted<AvailableFrom v="3.3.78" />A boolean indicating whether the bucket already existed or was newly created.