AWS SDK Version 2 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

.NET Framework 4.5
 
Container for the parameters to the AddEventSource operation. Identifies an Amazon Kinesis stream as the event source for an AWS Lambda function. AWS Lambda invokes the specified function when records are posted to the stream.

This is the pull model, where AWS Lambda invokes the function. For more information, go to AWS LambdaL How it Works in the AWS Lambda Developer Guide.

This association between an Amazon Kinesis stream and an AWS Lambda function is called the event source mapping. You provide the configuration information (for example, which stream to read from and which AWS Lambda function to invoke) for the event source mapping in the request body.

This operation requires permission for the

iam:PassRole
action for the IAM role. It also requires permission for the
lambda:AddEventSource
action.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Lambda.AmazonLambdaRequest
      Amazon.Lambda.Model.AddEventSourceRequest

Namespace: Amazon.Lambda.Model
Assembly: AWSSDK.dll
Version: 0.0.3.0

Syntax

C#
public class AddEventSourceRequest : AmazonLambdaRequest
         IRequestEvents

The AddEventSourceRequest type exposes the following members

Constructors

  Name Description
Public Method AddEventSourceRequest()

Properties

  Name Description
Public Property BatchSize Gets and sets the property BatchSize.

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

Public Property EventSource Gets and sets the property EventSource.

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.

Public Property FunctionName Gets and sets the property FunctionName.

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

Public Property Parameters Gets and sets the property Parameters.

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.

Public Property Role Gets and sets the property Role.

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

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8

.NET for Windows Phone:
Supported in: Windows Phone 8.1, Windows Phone 8