Interface IStreamEventSourceProps
The set of properties for streaming event sources shared by Dynamo and Kinesis.
Inherited Members
Namespace: Amazon.CDK.AWS.Lambda.EventSources
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStreamEventSourceProps : IBaseStreamEventSourceProps
Syntax (vb)
Public Interface IStreamEventSourceProps
Inherits IBaseStreamEventSourceProps
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;
using Amazon.CDK.AWS.Lambda;
using Amazon.CDK.AWS.Lambda.EventSources;
IEventSourceDlq eventSourceDlq;
var filters;
var streamEventSourceProps = new StreamEventSourceProps {
StartingPosition = StartingPosition.TRIM_HORIZON,
// the properties below are optional
BatchSize = 123,
BisectBatchOnError = false,
Enabled = false,
Filters = new [] { new Dictionary<string, object> {
{ "filtersKey", filters }
} },
MaxBatchingWindow = Duration.Minutes(30),
MaxRecordAge = Duration.Minutes(30),
OnFailure = eventSourceDlq,
ParallelizationFactor = 123,
ReportBatchItemFailures = false,
RetryAttempts = 123,
TumblingWindow = Duration.Minutes(30)
};
Synopsis
Properties
BisectBatchOnError | If the function returns an error, split the batch in two and retry. |
Filters | Add filter criteria option. |
MaxRecordAge | The maximum age of a record that Lambda sends to a function for processing. |
OnFailure | An Amazon SQS queue or Amazon SNS topic destination for discarded records. |
ParallelizationFactor | The number of batches to process from each shard concurrently. |
ReportBatchItemFailures | Allow functions to return partially successful responses for a batch of records. |
RetryAttempts | Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000. |
TumblingWindow | The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes. |
Properties
BisectBatchOnError
If the function returns an error, split the batch in two and retry.
virtual Nullable<bool> BisectBatchOnError { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Filters
Add filter criteria option.
virtual IDictionary<string, object>[] Filters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>[]
Remarks
Default: - None
MaxRecordAge
The maximum age of a record that Lambda sends to a function for processing.
virtual Duration MaxRecordAge { get; }
Property Value
Remarks
Valid Range:
The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, Lambda never discards old records. Record are valid until it expires in the event source.
Default: -1
OnFailure
An Amazon SQS queue or Amazon SNS topic destination for discarded records.
virtual IEventSourceDlq OnFailure { get; }
Property Value
Remarks
Default: - discarded records are ignored
ParallelizationFactor
The number of batches to process from each shard concurrently.
virtual Nullable<double> ParallelizationFactor { get; }
Property Value
System.Nullable<System.Double>
Remarks
Valid Range:
Default: 1
ReportBatchItemFailures
Allow functions to return partially successful responses for a batch of records.
virtual Nullable<bool> ReportBatchItemFailures { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
RetryAttempts
Maximum number of retry attempts Valid Range: * Minimum value of 0 * Maximum value of 10000.
virtual Nullable<double> RetryAttempts { get; }
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, Lambda retries failed records until the record expires in the event source.
Default: -1
TumblingWindow
The size of the tumbling windows to group records sent to DynamoDB or Kinesis Valid Range: 0 - 15 minutes.
virtual Duration TumblingWindow { get; }
Property Value
Remarks
Default: - None