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

Class: Aws::Lambda::Types::UpdateEventSourceMappingRequest

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

{
  uuid: "String", # required
  function_name: "FunctionName",
  enabled: false,
  batch_size: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#batch_sizeInteger

The maximum number of stream records that can be sent to your Lambda function for a single invocation.

Returns:

  • (Integer)


1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1918

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size)
  include Aws::Structure
end

#enabledBoolean

Specifies whether AWS Lambda should actively poll the stream or not. If disabled, AWS Lambda will not poll the stream.

Returns:

  • (Boolean)


1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1918

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size)
  include Aws::Structure
end

#function_nameString

The Lambda function to which you want the stream records sent.

You can specify a function name (for example, Thumbnail) or you can specify Amazon Resource Name (ARN) of the function (for example, arn:aws:lambda:us-west-2:account-id:function:ThumbNail). AWS Lambda also allows you to specify a partial ARN (for example, account-id:Thumbnail). 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.

If you are using versioning, you can also provide a qualified function ARN (ARN that is qualified with function version or alias name as suffix). For more information about versioning, see AWS Lambda Function Versioning and Aliases

Note that the length constraint applies only to the ARN. If you specify only the function name, it is limited to 64 character in length.

Returns:

  • (String)


1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1918

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size)
  include Aws::Structure
end

#uuidString

The event source mapping identifier.

Returns:

  • (String)


1918
1919
1920
1921
1922
1923
1924
# File 'gems/aws-sdk-lambda/lib/aws-sdk-lambda/types.rb', line 1918

class UpdateEventSourceMappingRequest < Struct.new(
  :uuid,
  :function_name,
  :enabled,
  :batch_size)
  include Aws::Structure
end