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

Class: Aws::LambdaPreview::Types::AddEventSourceRequest

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

{
  event_source: "String", # required
  function_name: "FunctionName", # required
  role: "RoleArn", # required
  batch_size: 1,
  parameters: {
    "String" => "String",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#batch_sizeInteger

The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.

Returns:

  • (Integer)


61
62
63
64
65
66
67
68
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 61

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  include Aws::Structure
end

#event_sourceString

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source. Any record added to this stream causes AWS Lambda to invoke your Lambda function. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

Returns:

  • (String)


61
62
63
64
65
66
67
68
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 61

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  include Aws::Structure
end

#function_nameString

The Lambda function to invoke when AWS Lambda detects an event on the stream.

Returns:

  • (String)


61
62
63
64
65
66
67
68
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 61

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  include Aws::Structure
end

#parametersHash<String,String>

A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source. Currently, AWS Lambda supports only the InitialPositionInStream key. The valid values are: "TRIM_HORIZON" and "LATEST". The default value is "TRIM_HORIZON". For more information, go to ShardIteratorType in the Amazon Kinesis Service API Reference.

Returns:

  • (Hash<String,String>)


61
62
63
64
65
66
67
68
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 61

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  include Aws::Structure
end

#roleString

The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.

Returns:

  • (String)


61
62
63
64
65
66
67
68
# File 'gems/aws-sdk-lambdapreview/lib/aws-sdk-lambdapreview/types.rb', line 61

class AddEventSourceRequest < Struct.new(
  :event_source,
  :function_name,
  :role,
  :batch_size,
  :parameters)
  include Aws::Structure
end