Class KinesisEventSource

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

Inheritance
System.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)
KinesisEventSource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
KinesisEventSource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

Properties

EventSourceMappingArn

The ARN for this EventSourceMapping.
EventSourceMappingId

The identifier for this EventSourceMapping.
Stream

Methods

Bind(IFunction)

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

Constructors

KinesisEventSource(IStream, IKinesisEventSourceProps)

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

KinesisEventSource(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected KinesisEventSource(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

KinesisEventSource(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected KinesisEventSource(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

EventSourceMappingArn

The ARN for this EventSourceMapping.

public virtual string EventSourceMappingArn { get; }
Property Value

System.String

EventSourceMappingId

The identifier for this EventSourceMapping.

public virtual string EventSourceMappingId { get; }
Property Value

System.String

Stream

public virtual IStream Stream { get; }
Property Value

IStream

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

Implements