Package software.amazon.awscdk.services.pipes.sources.alpha

Enum KinesisStartingPosition

java.lang.Object

java.lang.Enum<KinesisStartingPosition>

software.amazon.awscdk.services.pipes.sources.alpha.KinesisStartingPosition

All Implemented Interfaces:

Serializable, Comparable<KinesisStartingPosition>, java.lang.constant.Constable

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:25:08.310Z")
@Stability(Experimental)
public enum KinesisStartingPosition
extends Enum<KinesisStartingPosition>

(experimental) The position in a Kinesis stream from which to start reading.

Example:

 Stream sourceStream;
 Queue targetQueue;
 KinesisSource pipeSource = KinesisSource.Builder.create(sourceStream)
         .startingPosition(KinesisStartingPosition.LATEST)
         .build();
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .source(pipeSource)
         .target(new SqsTarget(targetQueue))
         .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	(experimental) Start streaming from the position denoted by the time stamp specified in the startingPositionTimestamp field.
LATEST	(experimental) Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.
TRIM_HORIZON	(experimental) Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

Method Summary

Modifier and Type	Method	Description
static KinesisStartingPosition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static KinesisStartingPosition[]	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(Experimental)
public static final KinesisStartingPosition TRIM_HORIZON

(experimental) Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.

LATEST

@Stability(Experimental)
public static final KinesisStartingPosition LATEST

(experimental) Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.

AT_TIMESTAMP

@Stability(Experimental)
public static final KinesisStartingPosition AT_TIMESTAMP

(experimental) Start streaming from the position denoted by the time stamp specified in the startingPositionTimestamp field.

Method Details

values

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