Package software.amazon.awscdk.services.lambda.eventsources

Interface KinesisEventSourceProps

All Superinterfaces:

BaseStreamEventSourceProps, software.amazon.jsii.JsiiSerializable, StreamEventSourceProps

All Known Implementing Classes:

KinesisEventSourceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:12.240Z")
@Stability(Stable)
public interface KinesisEventSourceProps
extends software.amazon.jsii.JsiiSerializable, StreamEventSourceProps

Example:

 import software.amazon.awscdk.services.kinesis.*;
 import software.amazon.awscdk.services.lambda.eventsources.KinesisEventSource;
 Function myFunction;
 Stream stream = new Stream(this, "MyStream");
 myFunction.addEventSource(KinesisEventSource.Builder.create(stream)
         .batchSize(100) // default
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	KinesisEventSourceProps.Builder	A builder for KinesisEventSourceProps
static final class	KinesisEventSourceProps.Jsii$Proxy	An implementation for KinesisEventSourceProps

Method Summary

Modifier and Type	Method	Description
static KinesisEventSourceProps.Builder	builder()
default Number	getStartingPositionTimestamp()	The time from which to start reading, in Unix time seconds.

Methods inherited from interface software.amazon.awscdk.services.lambda.eventsources.BaseStreamEventSourceProps

getBatchSize, getEnabled, getMaxBatchingWindow, getStartingPosition

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.lambda.eventsources.StreamEventSourceProps

getBisectBatchOnError, getFilterEncryption, getFilters, getMaxRecordAge, getOnFailure, getParallelizationFactor, getReportBatchItemFailures, getRetryAttempts, getTumblingWindow

Method Details

getStartingPositionTimestamp

@Stability(Stable)
@Nullable
default Number getStartingPositionTimestamp()

The time from which to start reading, in Unix time seconds.

Default: - no timestamp

builder

@Stability(Stable)
static KinesisEventSourceProps.Builder builder()

Returns:

a KinesisEventSourceProps.Builder of KinesisEventSourceProps