Package software.amazon.awscdk.services.pipes

Interface CfnPipe.PipeSourceKinesisStreamParametersProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnPipe.PipeSourceKinesisStreamParametersProperty.Jsii$Proxy
Enclosing class:
CfnPipe
@Stability(Stable) public static interface CfnPipe.PipeSourceKinesisStreamParametersProperty extends software.amazon.jsii.JsiiSerializable
The parameters for using a Kinesis stream as a source.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pipes.*;
 PipeSourceKinesisStreamParametersProperty pipeSourceKinesisStreamParametersProperty = PipeSourceKinesisStreamParametersProperty.builder()
         .startingPosition("startingPosition")
         // the properties below are optional
         .batchSize(123)
         .deadLetterConfig(DeadLetterConfigProperty.builder()
                 .arn("arn")
                 .build())
         .maximumBatchingWindowInSeconds(123)
         .maximumRecordAgeInSeconds(123)
         .maximumRetryAttempts(123)
         .onPartialBatchItemFailure("onPartialBatchItemFailure")
         .parallelizationFactor(123)
         .startingPositionTimestamp("startingPositionTimestamp")
         .build();

  • Method Details

    • getStartingPosition

      @Stability(Stable) @NotNull String getStartingPosition()
      (Streams only) The position in a stream from which to start reading.

    • getBatchSize

      @Stability(Stable) @Nullable default Number getBatchSize()
      The maximum number of records to include in each batch.

    • getDeadLetterConfig

      @Stability(Stable) @Nullable default Object getDeadLetterConfig()
      Define the target queue to send dead-letter queue events to.

    • getMaximumBatchingWindowInSeconds

      @Stability(Stable) @Nullable default Number getMaximumBatchingWindowInSeconds()
      The maximum length of a time to wait for events.

    • getMaximumRecordAgeInSeconds

      @Stability(Stable) @Nullable default Number getMaximumRecordAgeInSeconds()
      (Streams only) Discard records older than the specified age.

      The default value is -1, which sets the maximum age to infinite. When the value is set to infinite, EventBridge never discards old records.

    • getMaximumRetryAttempts

      @Stability(Stable) @Nullable default Number getMaximumRetryAttempts()
      (Streams only) Discard records after the specified number of retries.

      The default value is -1, which sets the maximum number of retries to infinite. When MaximumRetryAttempts is infinite, EventBridge retries failed records until the record expires in the event source.

    • getOnPartialBatchItemFailure

      @Stability(Stable) @Nullable default String getOnPartialBatchItemFailure()
      (Streams only) Define how to handle item process failures.

      AUTOMATIC_BISECT halves each batch and retry each half until all the records are processed or there is one failed message left in the batch.

    • getParallelizationFactor

      @Stability(Stable) @Nullable default Number getParallelizationFactor()
      (Streams only) The number of batches to process concurrently from each shard.

      The default value is 1.

    • getStartingPositionTimestamp

      @Stability(Stable) @Nullable default String getStartingPositionTimestamp()
      With StartingPosition set to AT_TIMESTAMP , the time from which to start reading, in Unix time seconds.

    • builder

      @Stability(Stable) static CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder builder()
      Returns:
      a CfnPipe.PipeSourceKinesisStreamParametersProperty.Builder of CfnPipe.PipeSourceKinesisStreamParametersProperty