interface PipeSourceKinesisStreamParametersProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awspipes#CfnPipe_PipeSourceKinesisStreamParametersProperty |
![]() | software.amazon.awscdk.services.pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty |
![]() | aws_cdk.aws_pipes.CfnPipe.PipeSourceKinesisStreamParametersProperty |
![]() | aws-cdk-lib » aws_pipes » CfnPipe » PipeSourceKinesisStreamParametersProperty |
The parameters for using a Kinesis stream as a source.
Example
// 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
Name | Type | Description |
---|---|---|
starting | string | The position in a stream from which to start reading. |
batch | number | The maximum number of records to include in each batch. |
dead | IResolvable | Dead | Define the target queue to send dead-letter queue events to. |
maximum | number | The maximum length of a time to wait for events. |
maximum | number | Discard records older than the specified age. |
maximum | number | Discard records after the specified number of retries. |
on | string | Define how to handle item process failures. |
parallelization | number | The number of batches to process concurrently from each shard. |
starting | string | With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds. |
startingPosition
Type:
string
The position in a stream from which to start reading.
batchSize?
Type:
number
(optional)
The maximum number of records to include in each batch.
deadLetterConfig?
Type:
IResolvable
|
Dead
(optional)
Define the target queue to send dead-letter queue events to.
maximumBatchingWindowInSeconds?
Type:
number
(optional)
The maximum length of a time to wait for events.
maximumRecordAgeInSeconds?
Type:
number
(optional)
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)
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:
string
(optional)
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?
Type:
number
(optional)
The number of batches to process concurrently from each shard.
The default value is 1.
startingPositionTimestamp?
Type:
string
(optional)
With StartingPosition
set to AT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.