Enum StartingPosition
- All Implemented Interfaces:
Serializable
,Comparable<StartingPosition>
,java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
date="2025-02-12T12:32:05.203Z")
@Stability(Stable)
public enum StartingPosition
extends Enum<StartingPosition>
The position in the DynamoDB, Kinesis or MSK stream where AWS Lambda should start reading.
Example:
import software.amazon.awscdk.services.lambda.eventsources.ManagedKafkaEventSource; Function myFunction; // Your MSK cluster arn String clusterArn = "arn:aws:kafka:us-east-1:0123456789019:cluster/SalesCluster/abcd1234-abcd-cafe-abab-9876543210ab-4"; // The Kafka topic you want to subscribe to String topic = "some-cool-topic"; myFunction.addEventSource(ManagedKafkaEventSource.Builder.create() .clusterArn(clusterArn) .topic(topic) .startingPosition(StartingPosition.TRIM_HORIZON) .filters(List.of(FilterCriteria.filter(Map.of( "stringEquals", FilterRule.isEqual("test"))))) .build());
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionStart reading from a position defined by a time stamp.Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard. -
Method Summary
Modifier and TypeMethodDescriptionstatic StartingPosition
Returns the enum constant of this type with the specified name.static StartingPosition[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
Enum Constant Details
-
TRIM_HORIZON
Start reading at the last untrimmed record in the shard in the system, which is the oldest data record in the shard. -
LATEST
Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard. -
AT_TIMESTAMP
Start reading from a position defined by a time stamp.Only supported for Amazon Kinesis streams, otherwise an error will occur. If supplied,
startingPositionTimestamp
must also be set.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-