You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::LambdaPreview::Types::AddEventSourceRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::LambdaPreview::Types::AddEventSourceRequest
- Defined in:
- (unknown)
Overview
When passing AddEventSourceRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
event_source: "String", # required
function_name: "FunctionName", # required
role: "RoleArn", # required
batch_size: 1,
parameters: {
"String" => "String",
},
}
Instance Attribute Summary collapse
-
#batch_size ⇒ Integer
The largest number of records that AWS Lambda will give to your function in a single event.
-
#event_source ⇒ String
The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the event source.
-
#function_name ⇒ String
The Lambda function to invoke when AWS Lambda detects an event on the stream.
-
#parameters ⇒ Hash<String,String>
A map (key-value pairs) defining the configuration for AWS Lambda to use when reading the event source.
-
#role ⇒ String
The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.
Instance Attribute Details
#batch_size ⇒ Integer
The largest number of records that AWS Lambda will give to your function in a single event. The default is 100 records.
#event_source ⇒ String
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.
#function_name ⇒ String
The Lambda function to invoke when AWS Lambda detects an event on the stream.
#parameters ⇒ Hash<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.
#role ⇒ String
The ARN of the IAM role (invocation role) that AWS Lambda can assume to read from the stream and invoke the function.