PipeSourceKinesisStreamParametersProperty Struct
The parameters for using a Kinesis stream as a source.
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
The maximum number of records to include in each batch.
deadLetterConfigIResolvable | CfnPipe.DeadLetterConfigPropertydead_letter_configtyping.Union[IResolvable, DeadLetterConfigProperty]deadLetterConfigIResolvableDeadLetterConfigIResolvableDeadLetterConfiginterface{}#Define the target queue to send dead-letter queue events to.
maximumBatchingWindowInSecondsnumbermaximum_batching_window_in_secondsint | floatmaximumBatchingWindowInSecondsNumberMaximumBatchingWindowInSecondsdoubleMaximumBatchingWindowInSeconds*float64#The maximum length of a time to wait for events.
maximumRecordAgeInSecondsnumbermaximum_record_age_in_secondsint | floatmaximumRecordAgeInSecondsNumberMaximumRecordAgeInSecondsdoubleMaximumRecordAgeInSeconds*float64#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.
maximumRetryAttemptsnumbermaximum_retry_attemptsint | floatmaximumRetryAttemptsNumberMaximumRetryAttemptsdoubleMaximumRetryAttempts*float64#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.
onPartialBatchItemFailurestringon_partial_batch_item_failurestronPartialBatchItemFailureStringOnPartialBatchItemFailurestringOnPartialBatchItemFailure*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.
parallelizationFactornumberparallelization_factorint | floatparallelizationFactorNumberParallelizationFactordoubleParallelizationFactor*float64#The number of batches to process concurrently from each shard.
The default value is 1.
startingPositionstringstarting_positionstrstartingPositionStringStartingPositionstringStartingPosition*stringrequired#The position in a stream from which to start reading.
startingPositionTimestampstringstarting_position_timestampstrstartingPositionTimestampStringStartingPositionTimestampstringStartingPositionTimestamp*string#With `StartingPosition` set to `AT_TIMESTAMP` , the time from which to start reading, in Unix time seconds.