Skip to main content

npx remotion lambda functions

The npx remotion lambda functions command allows you to deploy, view and delete AWS lambda functions that can render videos.

You only need one function per AWS region and Remotion version. Suggested reading: Do I need to deploy a function for each render?

deploy​

npx remotion lambda functions deploy
npx remotion lambda functions deploy

Creates a new function in your AWS account. If a function in the same region, with the same Remotion version, with the same amount of memory, disk space and timeout already exists, the name of the already deployed function will be returned instead.

By default, a CloudWatch Log Group will be created that will log debug information to CloudWatch that you can consult in the case something is going wrong. The default retention period for these logs is 14 days, which can be changed.

Example output

Region = eu-central-1,
Memory = 2048MB,
Disk = 2048MB,
Timeout = 120sec,
Version = 2021-12-17,
CloudWatch Enabled = true,
CloudWatch Retention Period = 14 days
VPC Subnet IDs = subnet-0f6a0f6a0f6a0f6a0, subnet-0f6a0f6a0f6a0f6a1
VPC Security Group IDs = sg-0f6a0f6a0f6a0f6a0, sg-0f6a0f6a0f6a0f6a1

Deployed as remotion-render-2021-12-17-2048mb-120sec

--region​

The AWS region to select.

--memory​

Memory size in megabytes. Default: 2048 MB.

--disk​

Disk size in megabytes. See also: Disk size.

Remotion VersionDefault
<5.0.02048MB
>=5.0.010240MB

--timeout​

Timeout of the Lambda function in seconds. Default: 120 seconds.

note

Not to be confused with the --timeout flag for npx remotion lambda render which defines the timeout for delayRender().

--disable-cloudwatch​

Does not create a CloudWatch log group.

--retention-period​

Retention period for the CloudWatch Logs in days. Default: 14 days.

--enable-lambda-insightsv4.0.61​

Enable Lambda Insights in AWS CloudWatch. For this to work, you may have to update your role permission.

--custom-role-arn​

Use a custom role for the function instead of the default (arn:aws:iam::[aws-account-id]:role/remotion-lambda-role)

--quiet, -q​

Only logs the function name.

--enable-v5-runtimev4.0.148​

Enable the upcoming v5 runtime with newer Chrome and Node versions early.

--vpc-subnet-idsv4.0.160​

Comma separated list of VPC subnet IDs to use for the Lambda function VPC configuration.

--vpc-security-group-idsv4.0.160​

Comma separated list of VPC security group IDs to use for the Lambda function VPC configuration.

--runtime-preferencev4.0.205​

One of:

  • default: Currently resolving to prefer-cjk
  • prefer-apple-emojis: Use Apple Emojis instead of Google Emojis. CJK characters will be removed.
  • prefer-cjk: Include CJK (Chinese, Japanese, Korean) characters and Google Emojis. Apple Emojis will be removed.
note

Apple Emojis are intellectual property of Apple Inc.
You are responsible for the use of Apple Emojis in your project.

ls​

npx remotion lambda functions ls
npx remotion lambda functions ls

Lists the functions that you have deployed to AWS in the selected region.

Example output

6 functions in the eu-central-1 region

Name                                              Version        Memory (MB)    Timeout (sec)  

remotion-render-2021-12-16-2048mb-240sec          2021-12-16     2048           240          

remotion-render-2021-12-17-2048mb-120sec          2021-12-17     2048           120          

remotion-render-2021-12-15-2048mb-240sec          2021-12-15     2048           240

--compatible-onlyv4.0.164​

Only lists functions that have the same version as the CLI you are calling the command from.

--region​

The AWS region to select.

--quiet, -q​

Prints only the function names in a space-separated list. If no functions exist, prints ()

rm​

npx remotion lambda functions rm remotion-render-2021-12-16-2048mb-240sec
npx remotion lambda functions rm remotion-render-2021-12-16-2048mb-240sec

Removes one or more functions from your AWS infrastructure. Pass a space-separated list of functions you'd like to delete.

Example output


Function name:   remotion-render-2021-12-16-2048mb-240sec

Memory:          2048MB

Timeout:         120sec

Version:         2021-12-16

Delete? (Y/n):  Y

Deleted!

--region​

The AWS region to select.

--yes, -y​

Skips confirmation.

rmall​

npx remotion lambda functions rmall
npx remotion lambda functions rmall

Removes all functions in a region from your AWS infrastructure.

Example output


Function name:   remotion-render-2021-12-16-2048mb-240sec

Memory:          2048MB

Timeout:         120sec

Version:         2021-12-16

Delete? (Y/n):  Y

Deleted!

Function name:   remotion-render-2021-12-18-2048mb-240sec

Memory:          2048MB

Timeout:         120sec

Version:         2021-12-16

Delete? (Y/n):  Y

Deleted!

--region​

The AWS region to select.

--yes, -y​

Skips confirmation.

See also​