Class CfnPipe.PipeSourceDynamoDBStreamParametersProperty
The parameters for using a DynamoDB stream as a source.
Inheritance
Namespace: Amazon.CDK.AWS.Pipes
Assembly: Amazon.CDK.AWS.Pipes.dll
Syntax (csharp)
public class PipeSourceDynamoDBStreamParametersProperty : Object, CfnPipe.IPipeSourceDynamoDBStreamParametersProperty
Syntax (vb)
Public Class PipeSourceDynamoDBStreamParametersProperty
Inherits Object
Implements CfnPipe.IPipeSourceDynamoDBStreamParametersProperty
Remarks
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 pipeSourceDynamoDBStreamParametersProperty = new PipeSourceDynamoDBStreamParametersProperty {
StartingPosition = "startingPosition",
// the properties below are optional
BatchSize = 123,
DeadLetterConfig = new DeadLetterConfigProperty {
Arn = "arn"
},
MaximumBatchingWindowInSeconds = 123,
MaximumRecordAgeInSeconds = 123,
MaximumRetryAttempts = 123,
OnPartialBatchItemFailure = "onPartialBatchItemFailure",
ParallelizationFactor = 123
};
Synopsis
Constructors
PipeSourceDynamoDBStreamParametersProperty() |
Properties
BatchSize | The maximum number of records to include in each batch. |
DeadLetterConfig | Define the target queue to send dead-letter queue events to. |
MaximumBatchingWindowInSeconds | The maximum length of a time to wait for events. |
MaximumRecordAgeInSeconds | (Streams only) Discard records older than the specified age. |
MaximumRetryAttempts | (Streams only) Discard records after the specified number of retries. |
OnPartialBatchItemFailure | (Streams only) Define how to handle item process failures. |
ParallelizationFactor | (Streams only) The number of batches to process concurrently from each shard. |
StartingPosition | (Streams only) The position in a stream from which to start reading. |
Constructors
PipeSourceDynamoDBStreamParametersProperty()
public PipeSourceDynamoDBStreamParametersProperty()
Properties
BatchSize
The maximum number of records to include in each batch.
public Nullable<double> BatchSize { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
DeadLetterConfig
Define the target queue to send dead-letter queue events to.
public object DeadLetterConfig { get; set; }
Property Value
System.Object
Remarks
MaximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
public Nullable<double> MaximumBatchingWindowInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
MaximumRecordAgeInSeconds
(Streams only) Discard records older than the specified age.
public Nullable<double> MaximumRecordAgeInSeconds { get; set; }
Property Value
System.Nullable<System.Double>
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
(Streams only) Discard records after the specified number of retries.
public Nullable<double> MaximumRetryAttempts { get; set; }
Property Value
System.Nullable<System.Double>
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
(Streams only) Define how to handle item process failures.
public string OnPartialBatchItemFailure { get; set; }
Property Value
System.String
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
(Streams only) The number of batches to process concurrently from each shard.
public Nullable<double> ParallelizationFactor { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
StartingPosition
(Streams only) The position in a stream from which to start reading.
public string StartingPosition { get; set; }
Property Value
System.String