EventSourceMappingOptions

class aws_cdk.aws_lambda.EventSourceMappingOptions(*, event_source_arn, batch_size=None, enabled=None, max_batching_window=None, starting_position=None)

Bases: object

__init__(*, event_source_arn, batch_size=None, enabled=None, max_batching_window=None, starting_position=None)
Parameters
  • event_source_arn (str) – The Amazon Resource Name (ARN) of the event source. Any record added to this stream can invoke the Lambda function.

  • batch_size (Union[int, float, None]) – 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. Valid Range: Minimum value of 1. Maximum value of 10000. Default: - Amazon Kinesis and Amazon DynamoDB is 100 records. Both the default and maximum for Amazon SQS are 10 messages.

  • enabled (Optional[bool]) – Set to false to disable the event source upon creation. Default: true

  • max_batching_window (Optional[Duration]) – The maximum amount of time to gather records before invoking the function. Maximum of Duration.minutes(5) Default: Duration.seconds(0)

  • starting_position (Optional[StartingPosition]) – The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading. Default: - Required for Amazon Kinesis and Amazon DynamoDB Streams sources.

Attributes

batch_size

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.

Valid Range: Minimum value of 1. Maximum value of 10000.

default :default:

  • Amazon Kinesis and Amazon DynamoDB is 100 records. Both the default and maximum for Amazon SQS are 10 messages.

Return type

Union[int, float, None]

enabled

Set to false to disable the event source upon creation.

default :default: true

Return type

Optional[bool]

event_source_arn

The Amazon Resource Name (ARN) of the event source.

Any record added to this stream can invoke the Lambda function.

Return type

str

max_batching_window

The maximum amount of time to gather records before invoking the function.

Maximum of Duration.minutes(5)

default :default: Duration.seconds(0)

Return type

Optional[Duration]

starting_position

The position in the DynamoDB or Kinesis stream where AWS Lambda should start reading.

default :default: - Required for Amazon Kinesis and Amazon DynamoDB Streams sources.

see :see: https://docs.aws.amazon.com/kinesis/latest/APIReference/API_GetShardIterator.html#Kinesis-GetShardIterator-request-ShardIteratorType

Return type

Optional[StartingPosition]