Class KinesisEventSource

Use an Amazon Kinesis stream as an event source for AWS Lambda.

Inheritance
object
StreamEventSource
KinesisEventSource
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.Lambda.EventSources
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class KinesisEventSource : StreamEventSource, IEventSource
Syntax (vb)
Public Class KinesisEventSource Inherits StreamEventSource Implements IEventSource
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Kinesis;
            using Amazon.CDK.AWS.Lambda.EventSources;

            Function myFunction;


            var stream = new Stream(this, "MyStream");
            myFunction.AddEventSource(new KinesisEventSource(stream, new KinesisEventSourceProps {
                BatchSize = 100,  // default
                StartingPosition = StartingPosition.TRIM_HORIZON
            }));

Synopsis

Constructors

KinesisEventSource(IStream, IKinesisEventSourceProps)

Use an Amazon Kinesis stream as an event source for AWS Lambda.

Properties

EventSourceMappingArn

The ARN for this EventSourceMapping.
EventSourceMappingId

The identifier for this EventSourceMapping.
Stream

Use an Amazon Kinesis stream as an event source for AWS Lambda.

Methods

Bind(IFunction)

Called by lambda.addEventSource to allow the event source to bind to this function.

Constructors

KinesisEventSource(IStream, IKinesisEventSourceProps)

Use an Amazon Kinesis stream as an event source for AWS Lambda.

public KinesisEventSource(IStream stream, IKinesisEventSourceProps props)
Parameters
stream IStream
props IKinesisEventSourceProps
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Kinesis;
            using Amazon.CDK.AWS.Lambda.EventSources;

            Function myFunction;


            var stream = new Stream(this, "MyStream");
            myFunction.AddEventSource(new KinesisEventSource(stream, new KinesisEventSourceProps {
                BatchSize = 100,  // default
                StartingPosition = StartingPosition.TRIM_HORIZON
            }));

Properties

EventSourceMappingArn

The ARN for this EventSourceMapping.

public virtual string EventSourceMappingArn { get; }
Property Value

string

Remarks

ExampleMetadata: infused

EventSourceMappingId

The identifier for this EventSourceMapping.

public virtual string EventSourceMappingId { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Stream

Use an Amazon Kinesis stream as an event source for AWS Lambda.

public virtual IStream Stream { get; }
Property Value

IStream

Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.Kinesis;
            using Amazon.CDK.AWS.Lambda.EventSources;

            Function myFunction;


            var stream = new Stream(this, "MyStream");
            myFunction.AddEventSource(new KinesisEventSource(stream, new KinesisEventSourceProps {
                BatchSize = 100,  // default
                StartingPosition = StartingPosition.TRIM_HORIZON
            }));

Methods

Bind(IFunction)

Called by lambda.addEventSource to allow the event source to bind to this function.

public override void Bind(IFunction target)
Parameters
target IFunction
Overrides
Remarks

ExampleMetadata: infused

Implements