Network.AWS.Lambda.CreateEventSourceMapping

Identifies a stream as an event source for a Lambda function. It can be either an Amazon Kinesis stream or an Amazon DynamoDB stream. AWS Lambda invokes the specified function when records are posted to the stream.

This association between a stream source and a Lambda function is called the event source mapping.

This event source mapping is relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. For more information, go to AWS Lambda: How it Works in the AWS Lambda Developer Guide.

You provide mapping information (for example, which stream to read from and which Lambda function to invoke) in the request body.

Each event source, such as an Amazon Kinesis or a DynamoDB stream, can be associated with multiple AWS Lambda function. A given Lambda function can be associated with multiple AWS event sources.

If you are using versioning, you can specify a specific function version or an alias via the function name parameter. For more information about versioning, see AWS Lambda Function Versioning and Aliases.

This operation requires permission for the 'lambda:CreateEventSourceMapping' action.

Creating a Request

createEventSourceMapping

Arguments

:: Text

cesmEventSourceARN

-> Text

cesmFunctionName

-> EventSourcePosition

cesmStartingPosition

-> CreateEventSourceMapping

Creates a value of CreateEventSourceMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cesmEnabled
• cesmBatchSize
• cesmEventSourceARN
• cesmFunctionName
• cesmStartingPosition

data CreateEventSourceMapping

See: createEventSourceMapping smart constructor.

Instances

Eq CreateEventSourceMapping

Data CreateEventSourceMapping

Read CreateEventSourceMapping

Show CreateEventSourceMapping

Generic CreateEventSourceMapping

ToJSON CreateEventSourceMapping

Hashable CreateEventSourceMapping

AWSRequest CreateEventSourceMapping

ToPath CreateEventSourceMapping

ToHeaders CreateEventSourceMapping

ToQuery CreateEventSourceMapping

type Rep CreateEventSourceMapping

type Rs CreateEventSourceMapping = EventSourceMappingConfiguration

Request Lenses

cesmEnabled :: Lens' CreateEventSourceMapping (Maybe Bool)

Indicates whether AWS Lambda should begin polling the event source. By default, Enabled is true.

cesmBatchSize :: Lens' CreateEventSourceMapping (Maybe Natural)

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records. The default is 100 records.

cesmEventSourceARN :: Lens' CreateEventSourceMapping Text

The Amazon Resource Name (ARN) of the Amazon Kinesis or the Amazon DynamoDB stream that is the event source. Any record added to this stream could cause AWS Lambda to invoke your Lambda function, it depends on the BatchSize. AWS Lambda POSTs the Amazon Kinesis event, containing records, to your Lambda function as JSON.

cesmFunctionName :: Lens' CreateEventSourceMapping Text

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

You can specify the 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').

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

AWS Lambda also allows you to specify only the function name with the account ID qualifier (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 character in length.

cesmStartingPosition :: Lens' CreateEventSourceMapping EventSourcePosition

The position in the stream where AWS Lambda should start reading. For more information, go to ShardIteratorType in the Amazon Kinesis API Reference.

Destructuring the Response

eventSourceMappingConfiguration :: EventSourceMappingConfiguration

Creates a value of EventSourceMappingConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• esmcEventSourceARN
• esmcState
• esmcFunctionARN
• esmcUUId
• esmcLastProcessingResult
• esmcBatchSize
• esmcStateTransitionReason
• esmcLastModified

data EventSourceMappingConfiguration

Describes mapping between an Amazon Kinesis stream and a Lambda function.

See: eventSourceMappingConfiguration smart constructor.

Instances

Eq EventSourceMappingConfiguration

Data EventSourceMappingConfiguration

Read EventSourceMappingConfiguration

Show EventSourceMappingConfiguration

Generic EventSourceMappingConfiguration

FromJSON EventSourceMappingConfiguration

Hashable EventSourceMappingConfiguration

type Rep EventSourceMappingConfiguration

Response Lenses

esmcEventSourceARN :: Lens' EventSourceMappingConfiguration (Maybe Text)

The Amazon Resource Name (ARN) of the Amazon Kinesis stream that is the source of events.

esmcState :: Lens' EventSourceMappingConfiguration (Maybe Text)

The state of the event source mapping. It can be Creating, Enabled, Disabled, Enabling, Disabling, Updating, or Deleting.

esmcFunctionARN :: Lens' EventSourceMappingConfiguration (Maybe Text)

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

esmcUUId :: Lens' EventSourceMappingConfiguration (Maybe Text)

The AWS Lambda assigned opaque identifier for the mapping.

esmcLastProcessingResult :: Lens' EventSourceMappingConfiguration (Maybe Text)

The result of the last AWS Lambda invocation of your Lambda function.

esmcBatchSize :: Lens' EventSourceMappingConfiguration (Maybe Natural)

The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. Your function receives an event with all the retrieved records.

esmcStateTransitionReason :: Lens' EventSourceMappingConfiguration (Maybe Text)

The reason the event source mapping is in its current state. It is either user-requested or an AWS Lambda-initiated state transition.

esmcLastModified :: Lens' EventSourceMappingConfiguration (Maybe UTCTime)

The UTC time string indicating the last time the event mapping was updated.