Skip to content

Creates an alias for a Lambda function version

Description

Creates an alias for a Lambda function version. Use aliases to provide clients with a function identifier that you can update to invoke a different version.

You can also map an alias to split invocation requests between two versions. Use the RoutingConfig parameter to specify a second version and the percentage of invocation requests that it receives.

Usage

lambda_create_alias(FunctionName, Name, FunctionVersion, Description,
  RoutingConfig)

Arguments

  • FunctionName

    [required] The name or ARN of the Lambda function.

    Name formats

    • Function name - MyFunction.
    • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:MyFunction.
    • Partial ARN - 123456789012:function:MyFunction.

    The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

  • Name

    [required] The name of the alias.

  • FunctionVersion

    [required] The function version that the alias invokes.

  • Description

    A description of the alias.

  • RoutingConfig

    The routing configuration of the alias.

Value

A list with the following syntax:

list(
  AliasArn = "string",
  Name = "string",
  FunctionVersion = "string",
  Description = "string",
  RoutingConfig = list(
    AdditionalVersionWeights = list(
      123.0
    )
  ),
  RevisionId = "string"
)

Request syntax

svc$create_alias(
  FunctionName = "string",
  Name = "string",
  FunctionVersion = "string",
  Description = "string",
  RoutingConfig = list(
    AdditionalVersionWeights = list(
      123.0
    )
  )
)

Examples

# The following example creates an alias named LIVE that points to version
# 1 of the my-function Lambda function.
svc$create_alias(
  Description = "alias for live version of function",
  FunctionName = "my-function",
  FunctionVersion = "1",
  Name = "LIVE"
)