# PipeSourceKinesisStreamParametersProperty

The parameters for using a Kinesis stream as a source.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_pipes as pipes } from 'aws-cdk-lib';
const pipeSourceKinesisStreamParametersProperty: pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty = {
  startingPosition: 'startingPosition',

  // the properties below are optional
  batchSize: 123,
  deadLetterConfig: {
    arn: 'arn',
  },
  maximumBatchingWindowInSeconds: 123,
  maximumRecordAgeInSeconds: 123,
  maximumRetryAttempts: 123,
  onPartialBatchItemFailure: 'onPartialBatchItemFailure',
  parallelizationFactor: 123,
  startingPositionTimestamp: 'startingPositionTimestamp',
};
```

## Properties

- `batchSize`: number — The maximum number of records to include in each batch.

- `deadLetterConfig`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnPipe.DeadLetterConfigProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_pipes.CfnPipe.DeadLetterConfigProperty.html) — Define the target queue to send dead-letter queue events to.

- `maximumBatchingWindowInSeconds`: number — The maximum length of a time to wait for events.

- `maximumRecordAgeInSeconds`: number — 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 — 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`: 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`: number — The number of batches to process concurrently from each shard.

  The default value is 1.

- `startingPosition`: string (required) — The position in a stream from which to start reading.

- `startingPositionTimestamp`: string — With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.