PipeSourceKinesisStreamParameters

import type { PipeSourceKinesisStreamParameters } from "https://aws-api.deno.dev/v0.4/services/pipes.ts?docs=full";

The parameters for using a Kinesis stream as a source.

interface PipeSourceKinesisStreamParameters {

BatchSize?: number | null;

DeadLetterConfig?: DeadLetterConfig | null;

MaximumBatchingWindowInSeconds?: number | null;

MaximumRecordAgeInSeconds?: number | null;

MaximumRetryAttempts?: number | null;

OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams | null;

ParallelizationFactor?: number | null;

StartingPosition: KinesisStreamStartPosition;

StartingPositionTimestamp?: Date | number | null;

}

§Properties

BatchSize?: number | null

[src]

The maximum number of records to include in each batch.

DeadLetterConfig?: DeadLetterConfig | null

[src]

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

MaximumBatchingWindowInSeconds?: number | null

[src]

The maximum length of a time to wait for events.

MaximumRecordAgeInSeconds?: number | null

[src]

(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.

MaximumRetryAttempts?: number | null

[src]

(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.

OnPartialBatchItemFailure?: OnPartialBatchItemFailureStreams | null

[src]

(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.

ParallelizationFactor?: number | null

[src]

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

StartingPosition: KinesisStreamStartPosition

[src]

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

StartingPositionTimestamp?: Date | number | null

[src]

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