interface StreamSourceParameters 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Pipes.Sources.Alpha.StreamSourceParameters`
Go	`github.com/aws/aws-cdk-go/awscdkpipessourcesalpha/v2#StreamSourceParameters`
Java	`software.amazon.awscdk.services.pipes.sources.alpha.StreamSourceParameters`
Python	`aws_cdk.aws_pipes_sources_alpha.StreamSourceParameters`
TypeScript (source)	`@aws-cdk/aws-pipes-sources-alpha` » `StreamSourceParameters`

Base parameters for streaming sources.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as pipes_sources_alpha from '@aws-cdk/aws-pipes-sources-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';

declare const queue: sqs.Queue;
const streamSourceParameters: pipes_sources_alpha.StreamSourceParameters = {
  batchSize: 123,
  deadLetterTarget: queue,
  maximumBatchingWindow: cdk.Duration.minutes(30),
  maximumRecordAge: cdk.Duration.minutes(30),
  maximumRetryAttempts: 123,
  onPartialBatchItemFailure: pipes_sources_alpha.OnPartialBatchItemFailure.AUTOMATIC_BISECT,
  parallelizationFactor: 123,
};

Properties

Name	Type	Description
batchSize?🔹	`number`	The maximum number of records to include in each batch.
deadLetterTarget?🔹	`IQueue` `\|` `ITopic`	Define the target to send dead-letter queue events to.
maximumBatchingWindow?🔹	`Duration`	The maximum length of a time to wait for events.
maximumRecordAge?🔹	`Duration`	Discard records older than the specified age.
maximumRetryAttempts?🔹	`number`	Discard records after the specified number of retries.
onPartialBatchItemFailure?🔹	`OnPartialBatchItemFailure`	Define how to handle item process failures.
parallelizationFactor?🔹	`number`	The number of batches to process concurrently from each shard.

batchSize?🔹

Type: number (optional, default: 1)

The maximum number of records to include in each batch.

deadLetterTarget?🔹

Type: IQueue | ITopic (optional, default: no dead-letter queue or topic)

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

The dead-letter queue stores any events that are not successfully delivered to a Pipes target after all retry attempts are exhausted. You can then resolve the issue that caused the failed invocations and replay the events at a later time. In some cases, such as when access is denied to a resource, events are sent directly to the dead-letter queue and are not retried.

maximumBatchingWindow?🔹

Type: Duration (optional, default: the events will be handled immediately)

The maximum length of a time to wait for events.

maximumRecordAge?🔹

Type: Duration (optional, default: -1 - EventBridge won't discard old records)

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?🔹

Type: number (optional, default: -1 - EventBridge will retry failed records until the record expires in the event source)

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?🔹

Type: OnPartialBatchItemFailure (optional, default: off - EventBridge will retry the entire batch)

Define how to handle item process failures.

{@link OnPartialBatchItemFailure.AUTOMATIC_BISECT} halves each batch and will retry each half until all the records are processed or there is one failed message left in the batch.

parallelizationFactor?🔹

Type: number (optional, default: 1)

The number of batches to process concurrently from each shard.