You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambda/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,
    },
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


1995
1996
1997
1998
1999
2000
2001
2002
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1995

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

#function_nameString

The function name for which the alias is created. Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 characters in length.

Returns:

  • (String)


1995
1996
1997
1998
1999
2000
2001
2002
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1995

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

#function_versionString

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

Returns:

  • (String)


1995
1996
1997
1998
1999
2000
2001
2002
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1995

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

#nameString

The alias name.

Returns:

  • (String)


1995
1996
1997
1998
1999
2000
2001
2002
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1995

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

#routing_configTypes::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 lambda-traffic-shifting-using-aliases.



1995
1996
1997
1998
1999
2000
2001
2002
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1995

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