serverless-pipes / Exports / KinesisStreamSourceParameters
It defines KinesisStream as the source for the EventBridge Pipes.
# serverless.yml
pipes:
pipeName:
source:
kinesisStream:
...properties- arn
- batchsize
- deadLetterArn
- maximumBatchingWindow
- maximumRecordAgeInSeconds
- maximumRetryAttempts
- onPartialBatchItemFailure
- parallelizationFactor
- startingPosition
- startingPositionTimestamp
• arn: object | string
The arn of the event source.
• batchsize: integer
The maximum number of records to include in each batch.
• deadLetterArn: object | string
Define the target queue arn to send dead-letter queue events to.
• maximumBatchingWindow: integer
The maximum length of a time to wait for events.
• maximumRetryAttempts: integer
Discard records after the specified number of retries. The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.
• maximumRecordAgeInSeconds: integer
Discard records older than the specified age. The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.
• onPartialBatchItemFailure: string
Define how to handle item process failures. AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.
• parallelizationFactor: integer
The number of batches to process concurrently from each shard. The default value is 1.
• startingPosition: string
The position in a stream from which to start reading.
Valid values: TRIM_HORIZON | LATEST
• startingPositionTimestamp: string
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.