Interface CfnPipe.IPipeSourceKinesisStreamParametersProperty
The parameters for using a Kinesis stream as a source.
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IPipeSourceKinesisStreamParametersPropertySyntax (vb)
Public Interface IPipeSourceKinesisStreamParametersPropertyRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Pipes;
var pipeSourceKinesisStreamParametersProperty = new PipeSourceKinesisStreamParametersProperty {
StartingPosition = "startingPosition",
// the properties below are optional
BatchSize = 123,
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
MaximumBatchingWindowInSeconds = 123,
MaximumRecordAgeInSeconds = 123,
MaximumRetryAttempts = 123,
OnPartialBatchItemFailure = "onPartialBatchItemFailure",
ParallelizationFactor = 123,
StartingPositionTimestamp = "startingPositionTimestamp"
};Synopsis
Properties
| Batch |
The maximum number of records to include in each batch. |
| Dead |
Define the target queue to send dead-letter queue events to. |
| Maximum |
The maximum length of a time to wait for events. |
| Maximum |
Discard records older than the specified age. |
| Maximum |
Discard records after the specified number of retries. |
| On |
Define how to handle item process failures. |
| Parallelization |
The number of batches to process concurrently from each shard. |
| Starting |
The position in a stream from which to start reading. |
| Starting |
With |
Properties
BatchSize
The maximum number of records to include in each batch.
virtual Nullable<double> BatchSize { get; }Property Value
System.
Remarks
DeadLetterConfig
Define the target queue to send dead-letter queue events to.
virtual object DeadLetterConfig { get; }Property Value
System.
Remarks
MaximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
virtual Nullable<double> MaximumBatchingWindowInSeconds { get; }Property Value
System.
Remarks
MaximumRecordAgeInSeconds
Discard records older than the specified age.
virtual Nullable<double> MaximumRecordAgeInSeconds { get; }Property Value
System.
Remarks
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
Discard records after the specified number of retries.
virtual Nullable<double> MaximumRetryAttempts { get; }Property Value
System.
Remarks
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
Define how to handle item process failures.
virtual string OnPartialBatchItemFailure { get; }Property Value
System.
Remarks
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
The number of batches to process concurrently from each shard.
virtual Nullable<double> ParallelizationFactor { get; }Property Value
System.
Remarks
StartingPosition
The position in a stream from which to start reading.
string StartingPosition { get; }Property Value
System.
Remarks
StartingPositionTimestamp
With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.
virtual string StartingPositionTimestamp { get; }Property Value
System.