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

Interface KinesisSourceParameters

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, StreamSourceParameters

All Known Implementing Classes:

KinesisSourceParameters.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:34.957Z")
@Stability(Experimental)
public interface KinesisSourceParameters
extends software.amazon.jsii.JsiiSerializable, StreamSourceParameters

(experimental) Parameters for the Kinesis source.

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

Modifier and Type	Interface	Description
static final class	KinesisSourceParameters.Builder	A builder for KinesisSourceParameters
static final class	KinesisSourceParameters.Jsii$Proxy	An implementation for KinesisSourceParameters

Method Summary

Modifier and Type	Method	Description
static KinesisSourceParameters.Builder	builder()
KinesisStartingPosition	getStartingPosition()	(experimental) The position in a stream from which to start reading.
default Instant	getStartingPositionTimestamp()	(experimental) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in ISO 8601 format.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.pipes.sources.alpha.StreamSourceParameters

getBatchSize, getDeadLetterTarget, getMaximumBatchingWindow, getMaximumRecordAge, getMaximumRetryAttempts, getOnPartialBatchItemFailure, getParallelizationFactor

Method Details

getStartingPosition

@Stability(Experimental)
@NotNull
KinesisStartingPosition getStartingPosition()

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

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingposition

getStartingPositionTimestamp

@Stability(Experimental)
@Nullable
default Instant getStartingPositionTimestamp()

(experimental) With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in ISO 8601 format.

Default: - no starting position timestamp

Example:

 new Date(Date.UTC(1969, 10, 20, 0, 0, 0));
 

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pipes-pipe-pipesourcekinesisstreamparameters.html#cfn-pipes-pipe-pipesourcekinesisstreamparameters-startingpositiontimestamp

builder

@Stability(Experimental)
static KinesisSourceParameters.Builder builder()

Returns:

a KinesisSourceParameters.Builder of KinesisSourceParameters