SqsEventSource

class aws_cdk.aws_lambda_event_sources.SqsEventSource(queue, *, batch_size=None, enabled=None, max_batching_window=None)

Bases: object

Use an Amazon SQS queue as an event source for AWS Lambda.

Example:

from aws_cdk.aws_lambda_event_sources import SqsEventSource

# fn is of type Function

queue = sqs.Queue(self, "MyQueue")
event_source = SqsEventSource(queue)
fn.add_event_source(event_source)

event_source_id = event_source.event_source_mapping_id
Parameters
  • queue (IQueue) –

  • 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 10. If maxBatchingWindow is configured, this value can go up to 10,000. Default: 10

  • enabled (Optional[bool]) – If the SQS event source mapping should be enabled. Default: true

  • max_batching_window (Optional[Duration]) – The maximum amount of time to gather records before invoking the function. Valid Range: Minimum value of 0 minutes. Maximum value of 5 minutes. Default: - no batching window. The lambda function will be invoked immediately with the records that are available.

Methods

bind(target)

Called by lambda.addEventSource to allow the event source to bind to this function.

Parameters

target (IFunction) –

Return type

None

Attributes

event_source_mapping_id

The identifier for this EventSourceMapping.

Return type

str

queue
Return type

IQueue