Interface PipeSourceKinesisStreamParameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PipeSourceKinesisStreamParameters.Builder,PipeSourceKinesisStreamParameters>, SdkBuilder<PipeSourceKinesisStreamParameters.Builder,PipeSourceKinesisStreamParameters>, SdkPojo
Enclosing class:
PipeSourceKinesisStreamParameters
@Mutable @NotThreadSafe public static interface PipeSourceKinesisStreamParameters.Builder extends SdkPojo, CopyableBuilder<PipeSourceKinesisStreamParameters.Builder,PipeSourceKinesisStreamParameters>

  • Method Details

    • batchSize

      PipeSourceKinesisStreamParameters.Builder batchSize(Integer batchSize)

      The maximum number of records to include in each batch.

      Parameters:
      batchSize - The maximum number of records to include in each batch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deadLetterConfig

      PipeSourceKinesisStreamParameters.Builder deadLetterConfig(DeadLetterConfig deadLetterConfig)

      Define the target queue to send dead-letter queue events to.

      Parameters:
      deadLetterConfig - Define the target queue to send dead-letter queue events to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deadLetterConfig

      default PipeSourceKinesisStreamParameters.Builder deadLetterConfig(Consumer<DeadLetterConfig.Builder> deadLetterConfig)

      Define the target queue to send dead-letter queue events to.

      This is a convenience method that creates an instance of the DeadLetterConfig.Builder avoiding the need to create one manually via DeadLetterConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deadLetterConfig(DeadLetterConfig).

      Parameters:
      deadLetterConfig - a consumer that will call methods on DeadLetterConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onPartialBatchItemFailure

      PipeSourceKinesisStreamParameters.Builder onPartialBatchItemFailure(String onPartialBatchItemFailure)

      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.

      Parameters:
      onPartialBatchItemFailure - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • onPartialBatchItemFailure

      PipeSourceKinesisStreamParameters.Builder onPartialBatchItemFailure(OnPartialBatchItemFailureStreams onPartialBatchItemFailure)

      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.

      Parameters:
      onPartialBatchItemFailure - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maximumBatchingWindowInSeconds

      PipeSourceKinesisStreamParameters.Builder maximumBatchingWindowInSeconds(Integer maximumBatchingWindowInSeconds)

      The maximum length of a time to wait for events.

      Parameters:
      maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumRecordAgeInSeconds

      PipeSourceKinesisStreamParameters.Builder maximumRecordAgeInSeconds(Integer maximumRecordAgeInSeconds)

      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.

      Parameters:
      maximumRecordAgeInSeconds - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maximumRetryAttempts

      PipeSourceKinesisStreamParameters.Builder maximumRetryAttempts(Integer maximumRetryAttempts)

      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.

      Parameters:
      maximumRetryAttempts - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parallelizationFactor

      PipeSourceKinesisStreamParameters.Builder parallelizationFactor(Integer parallelizationFactor)

      The number of batches to process concurrently from each shard. The default value is 1.

      Parameters:
      parallelizationFactor - The number of batches to process concurrently from each shard. The default value is 1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startingPosition

      PipeSourceKinesisStreamParameters.Builder startingPosition(String startingPosition)

      The position in a stream from which to start reading.

      Parameters:
      startingPosition - The position in a stream from which to start reading.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startingPosition

      PipeSourceKinesisStreamParameters.Builder startingPosition(KinesisStreamStartPosition startingPosition)

      The position in a stream from which to start reading.

      Parameters:
      startingPosition - The position in a stream from which to start reading.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startingPositionTimestamp

      PipeSourceKinesisStreamParameters.Builder startingPositionTimestamp(Instant startingPositionTimestamp)

      With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

      Parameters:
      startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.