Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
create-alias
--function-name <value>
--name <value>
--function-version <value>
[--description <value>]
[--routing-config <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--function-name
(string)
The name 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
(string)
The name of the alias.
--function-version
(string)
The function version that the alias invokes.
--description
(string)
A description of the alias.
--routing-config
(structure)
The routing configuration of the alias.
AdditionalVersionWeights -> (map)
The second version, and the percentage of traffic that's routed to it.
key -> (string)
value -> (double)
Shorthand Syntax:
AdditionalVersionWeights={KeyName1=double,KeyName2=double}
JSON Syntax:
{
"AdditionalVersionWeights": {"string": double
...}
}
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See 'aws help' for descriptions of global parameters.
To create an alias for a Lambda function
The following create-alias
example creates an alias named LIVE
that points to version 1 of the my-function
Lambda function.
aws lambda create-alias \
--function-name my-function \
--description "alias for live version of function" \
--function-version 1 \
--name LIVE
Output:
{
"FunctionVersion": "1",
"Name": "LIVE",
"AliasArn": "arn:aws:lambda:us-west-2:123456789012:function:my-function:LIVE",
"RevisionId": "873282ed-4cd3-4dc8-a069-d0c647e470c6",
"Description": "alias for live version of function"
}
For more information, see Configuring AWS Lambda Function Aliases in the AWS Lambda Developer Guide.
AliasArn -> (string)
The Amazon Resource Name (ARN) of the alias.
Name -> (string)
The name of the alias.
FunctionVersion -> (string)
The function version that the alias invokes.
Description -> (string)
A description of the alias.
RoutingConfig -> (structure)
The routing configuration of the alias.
AdditionalVersionWeights -> (map)
The second version, and the percentage of traffic that's routed to it.
key -> (string)
value -> (double)
RevisionId -> (string)
A unique identifier that changes when you update the alias.