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

Inherits:

Struct

• Object
• Struct
• Aws::Lambda::Types::UpdateAliasRequest

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:

• AWS API Documentation

Instance Attribute Summary

• #description ⇒ String

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

• #function_name ⇒ String

  The function name for which the alias is created.

• #function_version ⇒ String

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

• #name ⇒ String

  The alias name.

• #revision_id ⇒ String

  An optional value you can use to ensure you are updating the latest update of the function version or alias.

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

Instance Attribute Details

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2106

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

#function_name ⇒ String

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)

# File 'lib/aws-sdk-lambda/types.rb', line 2106

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)

# File 'lib/aws-sdk-lambda/types.rb', line 2106

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)

# File 'lib/aws-sdk-lambda/types.rb', line 2106

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 to retrieve the latest function version or alias `RevisionID` using either or .

Returns:

• (String)

# File 'lib/aws-sdk-lambda/types.rb', line 2106

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

Returns:

• (Types::AliasRoutingConfiguration)

# File 'lib/aws-sdk-lambda/types.rb', line 2106

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