Class: Aws::LambdaPreview::Types::UploadFunctionRequest

Inherits:

Struct

• Object
• Struct
• Aws::LambdaPreview::Types::UploadFunctionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-lambdapreview/types.rb

Overview

Note:

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

{
  function_name: "FunctionName", # required
  function_zip: "data", # required
  runtime: "nodejs", # required, accepts nodejs
  role: "RoleArn", # required
  handler: "Handler", # required
  mode: "event", # required, accepts event
  description: "Description",
  timeout: 1,
  memory_size: 1,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #description ⇒ String

  A short, user-defined function description.

• #function_name ⇒ String

  The name you want to assign to the function you are uploading.

• #function_zip ⇒ IO

  A .zip file containing your packaged source code.

• #handler ⇒ String

  The function that Lambda calls to begin execution.

• #memory_size ⇒ Integer

  The amount of memory, in MB, your Lambda function is given.

• #mode ⇒ String

  How the Lambda function will be invoked.

• #role ⇒ String

  The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

• #runtime ⇒ String

  The runtime environment for the Lambda function you are uploading.

• #timeout ⇒ Integer

  The function execution time at which Lambda should terminate the function.

Instance Attribute Details

#description ⇒ String

A short, user-defined function description. Lambda does not use this value. Assign a meaningful description as you see fit.

Returns:

• (String)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#function_name ⇒ String

The name you want to assign to the function you are uploading. The function names appear in the console and are returned in the ListFunctions API. Function names are used to specify functions to other AWS Lambda APIs, such as InvokeAsync.

Returns:

• (String)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#function_zip ⇒ IO

A .zip file containing your packaged source code. For more information about creating a .zip file, go to [AWS LambdaL How it Works] in the AWS Lambda Developer Guide.

[1]: docs.aws.amazon.com/lambda/latest/dg/walkthrough-custom-events.html

Returns:

• (IO)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#handler ⇒ String

The function that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function.

Returns:

• (String)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#memory_size ⇒ Integer

The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU allocated to your function. Your function use-case determines your CPU and memory requirements. For example, database operation might need less memory compared to image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

• (Integer)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#mode ⇒ String

How the Lambda function will be invoked. Lambda supports only the “event” mode.

Returns:

• (String)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#role ⇒ String

The Amazon Resource Name (ARN) of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources.

Returns:

• (String)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#runtime ⇒ String

The runtime environment for the Lambda function you are uploading. Currently, Lambda supports only “nodejs” as the runtime.

Returns:

• (String)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#timeout ⇒ Integer

The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds.

Returns:

• (Integer)

# File 'lib/aws-sdk-lambdapreview/types.rb', line 615

class UploadFunctionRequest < Struct.new(
  :function_name,
  :function_zip,
  :runtime,
  :role,
  :handler,
  :mode,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end