software.amazon.awscdk.services.pipes.sources.alpha.KinesisStartingPosition Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pipes-sources-alpha Show documentation

The CDK Construct Library for Amazon EventBridge Pipes Sources

There is a newer version: 2.168.0-alpha.0

package software.amazon.awscdk.services.pipes.sources.alpha;

/**
 * (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();
 * 
 */
@javax.annotation.Generated(value = "jsii-pacmak/1.104.0 (build e79254c)", date = "2024-11-15T10:25:09.687Z")
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
@software.amazon.jsii.Jsii(module = software.amazon.awscdk.services.pipes.sources.alpha.$Module.class, fqn = "@aws-cdk/aws-pipes-sources-alpha.KinesisStartingPosition")
public enum KinesisStartingPosition {
    /**
     * (experimental) Start streaming at the last untrimmed record in the shard, which is the oldest data record in the shard.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    TRIM_HORIZON,
    /**
     * (experimental) Start streaming just after the most recent record in the shard, so that you always read the most recent data in the shard.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    LATEST,
    /**
     * (experimental) Start streaming from the position denoted by the time stamp specified in the startingPositionTimestamp field.
     */
    @software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Experimental)
    AT_TIMESTAMP,
}