software.amazon.awscdk.services.lambda

Enum StartingPosition

java.lang.Object

java.lang.Enum<StartingPosition>

software.amazon.awscdk.services.lambda.StartingPosition

All Implemented Interfaces:

Serializable, Comparable<StartingPosition>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.489Z")
 @Stability(value=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.dynamodb.*;
 import software.amazon.awscdk.services.lambda.eventsources.DynamoEventSource;
 import software.amazon.awscdk.services.lambda.eventsources.SqsDlq;
 Table table;
 Function fn;
 Queue deadLetterQueue = new Queue(this, "deadLetterQueue");
 fn.addEventSource(DynamoEventSource.Builder.create(table)
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .batchSize(5)
         .bisectBatchOnError(true)
         .onFailure(new SqsDlq(deadLetterQueue))
         .retryAttempts(10)
         .build());
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_TIMESTAMP Start reading from a position defined by a time stamp.
LATEST Start reading just after the most recent record in the shard, so that you always read the most recent data in the shard.
TRIM_HORIZON 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 Type	Method and Description
static StartingPosition	valueOf(String name) 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.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TRIM_HORIZON

@Stability(value=Stable)
public static final StartingPosition 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

@Stability(value=Stable)
public static final StartingPosition 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

@Stability(value=Stable)
public static final StartingPosition 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 Detail

values

public static StartingPosition[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StartingPosition c : StartingPosition.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StartingPosition valueOf(String name)

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 name

NullPointerException - if the argument is null