This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Pipes::Pipe PipeSourceKinesisStreamParameters
The parameters for using a Kinesis stream as a source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "BatchSize" :Integer, "DeadLetterConfig" :DeadLetterConfig, "MaximumBatchingWindowInSeconds" :Integer, "MaximumRecordAgeInSeconds" :Integer, "MaximumRetryAttempts" :Integer, "OnPartialBatchItemFailure" :String, "ParallelizationFactor" :Integer, "StartingPosition" :String, "StartingPositionTimestamp" :String}
YAML
BatchSize:IntegerDeadLetterConfig:DeadLetterConfigMaximumBatchingWindowInSeconds:IntegerMaximumRecordAgeInSeconds:IntegerMaximumRetryAttempts:IntegerOnPartialBatchItemFailure:StringParallelizationFactor:IntegerStartingPosition:StringStartingPositionTimestamp:String
Properties
BatchSize-
The maximum number of records to include in each batch.
Required: No
Type: Integer
Minimum:
1Maximum:
10000Update requires: No interruption
DeadLetterConfig-
Define the target queue to send dead-letter queue events to.
Required: No
Type: DeadLetterConfig
Update requires: No interruption
MaximumBatchingWindowInSeconds-
The maximum length of a time to wait for events.
Required: No
Type: Integer
Minimum:
0Maximum:
300Update requires: No interruption
MaximumRecordAgeInSeconds-
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.
Required: No
Type: Integer
Minimum:
-1Maximum:
604800Update requires: No interruption
MaximumRetryAttempts-
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.
Required: No
Type: Integer
Minimum:
-1Maximum:
10000Update requires: No interruption
OnPartialBatchItemFailure-
Define how to handle item process failures.
AUTOMATIC_BISECThalves each batch and retry each half until all the records are processed or there is one failed message left in the batch.Required: No
Type: String
Allowed values:
AUTOMATIC_BISECTUpdate requires: No interruption
ParallelizationFactor-
The number of batches to process concurrently from each shard. The default value is 1.
Required: No
Type: Integer
Minimum:
1Maximum:
10Update requires: No interruption
StartingPosition-
The position in a stream from which to start reading.
Required: Yes
Type: String
Allowed values:
TRIM_HORIZON | LATEST | AT_TIMESTAMPUpdate requires: Replacement
StartingPositionTimestamp-
With
StartingPositionset toAT_TIMESTAMP, the time from which to start reading, in Unix time seconds.Required: No
Type: String
Update requires: Replacement
