Interface IBaseStreamEventSourceProps
The set of properties for streaming event sources shared by Dynamo, Kinesis and Kafka.
Namespace: Amazon.CDK.AWS.Lambda.EventSources
Assembly: Amazon.CDK.AWS.Lambda.EventSources.dll
Syntax (csharp)
public interface IBaseStreamEventSourceProps
Syntax (vb)
Public Interface 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.AWS.Lambda;
using Amazon.CDK.AWS.Lambda.EventSources;
using Amazon.CDK;
var baseStreamEventSourceProps = new BaseStreamEventSourceProps {
StartingPosition = StartingPosition.TRIM_HORIZON,
// the properties below are optional
BatchSize = 123,
Enabled = false,
MaxBatchingWindow = Duration.Minutes(30)
};
Synopsis
Properties
BatchSize | The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function. |
Enabled | If the stream event source mapping should be enabled. |
MaxBatchingWindow | The maximum amount of time to gather records before invoking the function. |
StartingPosition | Where to begin consuming the stream. |
Properties
BatchSize
The largest number of records that AWS Lambda will retrieve from your event source at the time of invoking your function.
virtual Nullable<double> BatchSize { get; }
Property Value
System.Nullable<System.Double>
Remarks
Your function receives an event with all the retrieved records.
Valid Range:
Default: 100
Enabled
If the stream event source mapping should be enabled.
virtual Nullable<bool> Enabled { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true
MaxBatchingWindow
The maximum amount of time to gather records before invoking the function.
virtual Duration MaxBatchingWindow { get; }
Property Value
Remarks
Maximum of Duration.minutes(5)
Default: Duration.seconds(0)
StartingPosition
Where to begin consuming the stream.
StartingPosition StartingPosition { get; }
Property Value