View a markdown version of this page

Create an alias for a Lambda function - AWS Lambda

Create an alias for a Lambda function

You can create aliases for your Lambda function. A Lambda alias is a pointer to a function version that you can update. The function's users can access the function version using the alias Amazon Resource Name (ARN). When you deploy a new version, you can update the alias to use the new version, or split traffic between two versions. For more information about using aliases in your applications, see Using Lambda aliases in event sources and permissions policies.

Console
To create an alias using the console

  1. Open the Functions page of the Lambda console.

  2. Choose a function.

  3. Choose Aliases and then choose Create alias.

  4. On the Create alias page, do the following:

    1. Enter a Name for the alias.

    2. (Optional) Enter a Description for the alias.

    3. For Version, choose a function version that you want the alias to point to.

    4. (Optional) To configure routing on the alias, expand Weighted alias. For more information, see Implement Lambda canary deployments using a weighted alias.

    5. Choose Save.

AWS CLI

To create an alias using the AWS Command Line Interface (AWS CLI), use the create-alias command.

aws lambda create-alias \
  --function-name my-function \
  --name alias-name \
  --function-version version-number \
  --description " "

To change an alias to point a new version of the function, use the update-alias command.

aws lambda update-alias \
  --function-name my-function \
  --name alias-name \
  --function-version version-number

To delete an alias, use the delete-alias command.

aws lambda delete-alias \
  --function-name my-function \
  --name alias-name

The AWS CLI commands in the preceding steps correspond to the following Lambda API operations: