Class: Aws::Lambda::Types::UpdateAliasRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-lambda/types.rb

Overview

Note:

When making an API call, you may pass UpdateAliasRequest data as a hash:

{
  function_name: "FunctionName", # required
  name: "Alias", # required
  function_version: "Version",
  description: "Description",
  routing_config: {
    additional_version_weights: {
      "AdditionalVersion" => 1.0,
    },
  },
  revision_id: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

You can change the description of the alias using this parameter.

Returns:

  • (String) 


2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-lambda/types.rb', line 2113

class UpdateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config,
  :revision_id)
  include Aws::Structure
end

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

Returns:

  • (String) 


2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-lambda/types.rb', line 2113

class UpdateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config,
  :revision_id)
  include Aws::Structure
end

#function_version ⇒ String

Using this parameter you can change the Lambda function version to which the alias points.

Returns:

  • (String) 


2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-lambda/types.rb', line 2113

class UpdateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config,
  :revision_id)
  include Aws::Structure
end

#name ⇒ String

The alias name.

Returns:

  • (String) 


2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-lambda/types.rb', line 2113

class UpdateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config,
  :revision_id)
  include Aws::Structure
end

#revision_id ⇒ String

An optional value you can use to ensure you are updating the latest update of the function version or alias. If the RevisionID you pass doesn’t match the latest RevisionId of the function or alias, it will fail with an error message, advising you retrieve the latest function version or alias RevisionID using either GetFunction or GetAlias.

Returns:

  • (String) 


2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-lambda/types.rb', line 2113

class UpdateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config,
  :revision_id)
  include Aws::Structure
end

#routing_config ⇒ Types::AliasRoutingConfiguration

Specifies an additional version your alias can point to, allowing you to dictate what percentage of traffic will invoke each version. For more information, see [Traffic Shifting Using Aliases].

[1]: docs.aws.amazon.com/lambda/latest/dg/lambda-traffic-shifting-using-aliases.html

Returns:



2113
2114
2115
2116
2117
2118
2119
2120
2121
 
# File 'lib/aws-sdk-lambda/types.rb', line 2113

class UpdateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config,
  :revision_id)
  include Aws::Structure
end