Package 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>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:34:04.243Z")
@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.secretsmanager.Secret;
 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";
 // The secret that allows access to your MSK cluster
 // You still have to make sure that it is associated with your cluster as described in the documentation
 Secret secret = Secret.Builder.create(this, "Secret").secretName("AmazonMSK_KafkaSecret").build();
 myFunction.addEventSource(ManagedKafkaEventSource.Builder.create()
         .clusterArn(clusterArn)
         .topic(topic)
         .secret(secret)
         .batchSize(100) // default
         .startingPosition(StartingPosition.TRIM_HORIZON)
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TRIM_HORIZON

@Stability(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(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(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 Details

values

public static StartingPosition[] 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

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