Class: Aws::Lambda::Types::CreateAliasRequest

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 CreateAliasRequest data as a hash:

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

Description of the alias.

Returns:

  • (String) 


343
344
345
346
347
348
349
350
 
# File 'lib/aws-sdk-lambda/types.rb', line 343

class CreateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config)
  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) 


343
344
345
346
347
348
349
350
 
# File 'lib/aws-sdk-lambda/types.rb', line 343

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

#function_version ⇒ String

Lambda function version for which you are creating the alias.

Returns:

  • (String) 


343
344
345
346
347
348
349
350
 
# File 'lib/aws-sdk-lambda/types.rb', line 343

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

#name ⇒ String

Name for the alias you are creating.

Returns:

  • (String) 


343
344
345
346
347
348
349
350
 
# File 'lib/aws-sdk-lambda/types.rb', line 343

class CreateAliasRequest < Struct.new(
  :function_name,
  :name,
  :function_version,
  :description,
  :routing_config)
  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:



343
344
345
346
347
348
349
350
 
# File 'lib/aws-sdk-lambda/types.rb', line 343

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