StreamEventSourceProps

class aws_cdk.aws_lambda_event_sources.StreamEventSourceProps(*, batch_size=None, bisect_batch_on_error=None, enabled=None, max_batching_window=None, max_record_age=None, on_failure=None, parallelization_factor=None, report_batch_item_failures=None, retry_attempts=None, starting_position, tumbling_window=None)

Bases: object

The set of properties for event sources that follow the streaming model, such as, Dynamo, Kinesis and Kafka.

Parameters

  • 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: - 1000 for {@link DynamoEventSource} - 10000 for {@link KinesisEventSource} Default: 100

  • bisect_batch_on_error (Optional[bool]) – If the function returns an error, split the batch in two and retry. Default: false

  • enabled (Optional[bool]) – If the stream 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. Maximum of Duration.minutes(5) Default: Duration.seconds(0)

  • max_record_age (Optional[Duration]) – The maximum age of a record that Lambda sends to a function for processing. Valid Range: - Minimum value of 60 seconds - Maximum value of 7 days Default: - the retention period configured on the stream

  • on_failure (Optional[IEventSourceDlq]) – An Amazon SQS queue or Amazon SNS topic destination for discarded records. Default: discarded records are ignored

  • parallelization_factor (Union[int, float, None]) – The number of batches to process from each shard concurrently. Valid Range: - Minimum value of 1 - Maximum value of 10 Default: 1

  • report_batch_item_failures (Optional[bool]) – Allow functions to return partially successful responses for a batch of records. Default: false

  • retry_attempts (Union[int, float, None]) – Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000. Default: - retry until the record expires

  • starting_position (StartingPosition) – Where to begin consuming the stream.

  • tumbling_window (Optional[Duration]) – The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes. Default: - None

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_lambda as lambda_
import aws_cdk.aws_lambda_event_sources as lambda_event_sources
import aws_cdk.core as cdk

# event_source_dlq is of type IEventSourceDlq

stream_event_source_props = lambda_event_sources.StreamEventSourceProps(
    starting_position=lambda_.StartingPosition.TRIM_HORIZON,

    # the properties below are optional
    batch_size=123,
    bisect_batch_on_error=False,
    enabled=False,
    max_batching_window=cdk.Duration.minutes(30),
    max_record_age=cdk.Duration.minutes(30),
    on_failure=event_source_dlq,
    parallelization_factor=123,
    report_batch_item_failures=False,
    retry_attempts=123,
    tumbling_window=cdk.Duration.minutes(30)
)

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:

    • 1000 for {@link DynamoEventSource}

    • 10000 for {@link KinesisEventSource}

Default

100

Return type

Union[int, float, None]

bisect_batch_on_error

If the function returns an error, split the batch in two and retry.

Default

false

Return type

Optional[bool]

enabled

If the stream event source mapping should be enabled.

Default

true

Return type

Optional[bool]

max_batching_window

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

Maximum of Duration.minutes(5)

Default

Duration.seconds(0)

Return type

Optional[Duration]

max_record_age

The maximum age of a record that Lambda sends to a function for processing.

Valid Range:

  • Minimum value of 60 seconds

  • Maximum value of 7 days

Default

  • the retention period configured on the stream

Return type

Optional[Duration]

on_failure

An Amazon SQS queue or Amazon SNS topic destination for discarded records.

Default

discarded records are ignored

Return type

Optional[IEventSourceDlq]

parallelization_factor

The number of batches to process from each shard concurrently.

Valid Range:

  • Minimum value of 1

  • Maximum value of 10

Default

1

Return type

Union[int, float, None]

report_batch_item_failures

Allow functions to return partially successful responses for a batch of records.

Default

false

See

https://docs.aws.amazon.com/lambda/latest/dg/with-ddb.html#services-ddb-batchfailurereporting

Return type

Optional[bool]

retry_attempts

  • Minimum value of 0 * Maximum value of 10000.

Default

  • retry until the record expires

Type

Maximum number of retry attempts Valid Range

Return type

Union[int, float, None]

starting_position

Where to begin consuming the stream.

Return type

StartingPosition

tumbling_window

0 - 15 minutes.

Default

  • None

Type

The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range

Return type

Optional[Duration]