Documentation

The parameters for using a Kinesis stream as a source.

See: newPipeSourceKinesisStreamParameters smart constructor.

Create a value of PipeSourceKinesisStreamParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchSize:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_batchSize - The maximum number of records to include in each batch.

$sel:deadLetterConfig:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_deadLetterConfig - Define the target queue to send dead-letter queue events to.

$sel:maximumBatchingWindowInSeconds:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

$sel:maximumRecordAgeInSeconds:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds - (Streams only) 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.

$sel:maximumRetryAttempts:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumRetryAttempts - (Streams only) 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.

$sel:onPartialBatchItemFailure:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_onPartialBatchItemFailure - (Streams only) 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.

$sel:parallelizationFactor:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

$sel:startingPositionTimestamp:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

$sel:startingPosition:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_startingPosition - (Streams only) The position in a stream from which to start reading.

The maximum number of records to include in each batch.

Define the target queue to send dead-letter queue events to.

The maximum length of a time to wait for events.

(Streams only) 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.

(Streams only) 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.

(Streams only) 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.

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

(Streams only) The position in a stream from which to start reading.