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

Class: Aws::LambdaPreview::Types::UpdateFunctionConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb

Overview

Note:

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

{
  function_name: "FunctionName", # required
  role: "RoleArn",
  handler: "Handler",
  description: "Description",
  timeout: 1,
  memory_size: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

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

Returns:

  • (String)


529
530
531
532
533
534
535
536
537
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 529

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#function_nameString

The name of the Lambda function.

Returns:

  • (String)


529
530
531
532
533
534
535
536
537
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 529

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#handlerString

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

Returns:

  • (String)


529
530
531
532
533
534
535
536
537
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 529

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#memory_sizeInteger

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, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB.

Returns:

  • (Integer)


529
530
531
532
533
534
535
536
537
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 529

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#roleString

The Amazon Resource Name (ARN) of the IAM role that Lambda will assume when it executes your function.

Returns:

  • (String)


529
530
531
532
533
534
535
536
537
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 529

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end

#timeoutInteger

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)


529
530
531
532
533
534
535
536
537
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 529

class UpdateFunctionConfigurationRequest < Struct.new(
  :function_name,
  :role,
  :handler,
  :description,
  :timeout,
  :memory_size)
  include Aws::Structure
end