ContextQMD
Back to Remotion

npx remotion lambda functions deploy

packages/docs/docs/lambda/cli/functions/deploy.mdx

4.0.4623.0 KB
Original Source

import {DefaultMemorySize} from '../../../../components/lambda/default-memory-size'; import {DefaultTimeout} from '../../../../components/lambda/default-timeout'; import {DefaultLogRetention} from '../../../../components/lambda/default-log-retention';

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.

<details> <summary> Example output </summary> <pre> 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

</pre> </details>

--region

The AWS region to select.

--memory

Memory size in megabytes. Default: <DefaultMemorySize /> 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: <DefaultTimeout /> 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: <DefaultLogRetention /> days.

--enable-lambda-insights<AvailableFrom v="4.0.61" />

<Options id="enable-lambda-insights" />

--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.

--vpc-subnet-ids<AvailableFrom v="4.0.160" />

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

--vpc-security-group-ids<AvailableFrom v="4.0.160" />

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

--runtime-preference<AvailableFrom v="4.0.205" />

One of:

  • default: Currently resolving to cjk
  • apple-emojis: Use Apple Emojis instead of Google Emojis. CJK characters will be removed.
  • 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. :::