Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters

Description

Synopsis

Documentation

data PipeSourceKinesisStreamParameters Source #

The parameters for using a Kinesis stream as a source.

See: newPipeSourceKinesisStreamParameters smart constructor.

Constructors

PipeSourceKinesisStreamParameters'

Fields

batchSize :: Maybe Natural
The maximum number of records to include in each batch.
deadLetterConfig :: Maybe DeadLetterConfig
Define the target queue to send dead-letter queue events to.
maximumBatchingWindowInSeconds :: Maybe Natural
The maximum length of a time to wait for events.
maximumRecordAgeInSeconds :: Maybe Int
(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.
maximumRetryAttempts :: Maybe Int
(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.
onPartialBatchItemFailure :: Maybe OnPartialBatchItemFailureStreams
(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.
parallelizationFactor :: Maybe Natural
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
startingPositionTimestamp :: Maybe POSIX
With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.
startingPosition :: KinesisStreamStartPosition
(Streams only) The position in a stream from which to start reading.

Instances

Instances details

FromJSON PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods parseJSON :: Value -> Parser PipeSourceKinesisStreamParameters # parseJSONList :: Value -> Parser [PipeSourceKinesisStreamParameters] #
ToJSON PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods toJSON :: PipeSourceKinesisStreamParameters -> Value # toEncoding :: PipeSourceKinesisStreamParameters -> Encoding # toJSONList :: [PipeSourceKinesisStreamParameters] -> Value # toEncodingList :: [PipeSourceKinesisStreamParameters] -> Encoding #
Generic PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Associated Types type Rep PipeSourceKinesisStreamParameters :: Type -> Type # Methods from :: PipeSourceKinesisStreamParameters -> Rep PipeSourceKinesisStreamParameters x # to :: Rep PipeSourceKinesisStreamParameters x -> PipeSourceKinesisStreamParameters #
Read PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods readsPrec :: Int -> ReadS PipeSourceKinesisStreamParameters # readList :: ReadS [PipeSourceKinesisStreamParameters] # readPrec :: ReadPrec PipeSourceKinesisStreamParameters # readListPrec :: ReadPrec [PipeSourceKinesisStreamParameters] #
Show PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods showsPrec :: Int -> PipeSourceKinesisStreamParameters -> ShowS # show :: PipeSourceKinesisStreamParameters -> String # showList :: [PipeSourceKinesisStreamParameters] -> ShowS #
NFData PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods rnf :: PipeSourceKinesisStreamParameters -> () #
Eq PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods (==) :: PipeSourceKinesisStreamParameters -> PipeSourceKinesisStreamParameters -> Bool # (/=) :: PipeSourceKinesisStreamParameters -> PipeSourceKinesisStreamParameters -> Bool #
Hashable PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters Methods hashWithSalt :: Int -> PipeSourceKinesisStreamParameters -> Int # hash :: PipeSourceKinesisStreamParameters -> Int #
type Rep PipeSourceKinesisStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters type Rep PipeSourceKinesisStreamParameters = D1 ('MetaData "PipeSourceKinesisStreamParameters" "Amazonka.Pipes.Types.PipeSourceKinesisStreamParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeSourceKinesisStreamParameters'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "batchSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "deadLetterConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeadLetterConfig))) :: (S1 ('MetaSel ('Just "maximumBatchingWindowInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "maximumRecordAgeInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "maximumRetryAttempts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "onPartialBatchItemFailure") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OnPartialBatchItemFailureStreams))) :: (S1 ('MetaSel ('Just "parallelizationFactor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "startingPositionTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "startingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 KinesisStreamStartPosition))))))

newPipeSourceKinesisStreamParameters Source #

Arguments

:: KinesisStreamStartPosition	`$sel:startingPosition:PipeSourceKinesisStreamParameters'`
-> PipeSourceKinesisStreamParameters

Create a value of PipeSourceKinesisStreamParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:batchSize:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_batchSize - The maximum number of records to include in each batch.

$sel:deadLetterConfig:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_deadLetterConfig - Define the target queue to send dead-letter queue events to.

$sel:maximumBatchingWindowInSeconds:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds - The maximum length of a time to wait for events.

$sel:maximumRecordAgeInSeconds:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds - (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.

$sel:maximumRetryAttempts:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_maximumRetryAttempts - (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.

$sel:onPartialBatchItemFailure:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_onPartialBatchItemFailure - (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.

$sel:parallelizationFactor:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

$sel:startingPositionTimestamp:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_startingPositionTimestamp - With StartingPosition set to AT_TIMESTAMP, the time from which to start reading, in Unix time seconds.

$sel:startingPosition:PipeSourceKinesisStreamParameters', pipeSourceKinesisStreamParameters_startingPosition - (Streams only) The position in a stream from which to start reading.

pipeSourceKinesisStreamParameters_batchSize :: Lens' PipeSourceKinesisStreamParameters (Maybe Natural) Source #

The maximum number of records to include in each batch.

pipeSourceKinesisStreamParameters_deadLetterConfig :: Lens' PipeSourceKinesisStreamParameters (Maybe DeadLetterConfig) Source #

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

pipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceKinesisStreamParameters (Maybe Natural) Source #

The maximum length of a time to wait for events.

pipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds :: Lens' PipeSourceKinesisStreamParameters (Maybe Int) Source #

(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.

pipeSourceKinesisStreamParameters_maximumRetryAttempts :: Lens' PipeSourceKinesisStreamParameters (Maybe Int) Source #

(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.

pipeSourceKinesisStreamParameters_onPartialBatchItemFailure :: Lens' PipeSourceKinesisStreamParameters (Maybe OnPartialBatchItemFailureStreams) Source #

(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.

pipeSourceKinesisStreamParameters_parallelizationFactor :: Lens' PipeSourceKinesisStreamParameters (Maybe Natural) Source #

(Streams only) The number of batches to process concurrently from each shard. The default value is 1.

pipeSourceKinesisStreamParameters_startingPositionTimestamp :: Lens' PipeSourceKinesisStreamParameters (Maybe UTCTime) Source #

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

pipeSourceKinesisStreamParameters_startingPosition :: Lens' PipeSourceKinesisStreamParameters KinesisStreamStartPosition Source #

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