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

Description

Synopsis

Documentation

data PipeSourceDynamoDBStreamParameters Source #

The parameters for using a DynamoDB stream as a source.

See: newPipeSourceDynamoDBStreamParameters smart constructor.

Constructors

PipeSourceDynamoDBStreamParameters'

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.
startingPosition :: DynamoDBStreamStartPosition
(Streams only) The position in a stream from which to start reading.

Instances

Instances details

FromJSON PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods parseJSON :: Value -> Parser PipeSourceDynamoDBStreamParameters # parseJSONList :: Value -> Parser [PipeSourceDynamoDBStreamParameters] #
ToJSON PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods toJSON :: PipeSourceDynamoDBStreamParameters -> Value # toEncoding :: PipeSourceDynamoDBStreamParameters -> Encoding # toJSONList :: [PipeSourceDynamoDBStreamParameters] -> Value # toEncodingList :: [PipeSourceDynamoDBStreamParameters] -> Encoding #
Generic PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Associated Types type Rep PipeSourceDynamoDBStreamParameters :: Type -> Type # Methods from :: PipeSourceDynamoDBStreamParameters -> Rep PipeSourceDynamoDBStreamParameters x # to :: Rep PipeSourceDynamoDBStreamParameters x -> PipeSourceDynamoDBStreamParameters #
Read PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods readsPrec :: Int -> ReadS PipeSourceDynamoDBStreamParameters # readList :: ReadS [PipeSourceDynamoDBStreamParameters] # readPrec :: ReadPrec PipeSourceDynamoDBStreamParameters # readListPrec :: ReadPrec [PipeSourceDynamoDBStreamParameters] #
Show PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods showsPrec :: Int -> PipeSourceDynamoDBStreamParameters -> ShowS # show :: PipeSourceDynamoDBStreamParameters -> String # showList :: [PipeSourceDynamoDBStreamParameters] -> ShowS #
NFData PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods rnf :: PipeSourceDynamoDBStreamParameters -> () #
Eq PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods (==) :: PipeSourceDynamoDBStreamParameters -> PipeSourceDynamoDBStreamParameters -> Bool # (/=) :: PipeSourceDynamoDBStreamParameters -> PipeSourceDynamoDBStreamParameters -> Bool #
Hashable PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters Methods hashWithSalt :: Int -> PipeSourceDynamoDBStreamParameters -> Int # hash :: PipeSourceDynamoDBStreamParameters -> Int #
type Rep PipeSourceDynamoDBStreamParameters Source #
Instance details Defined in Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters type Rep PipeSourceDynamoDBStreamParameters = D1 ('MetaData "PipeSourceDynamoDBStreamParameters" "Amazonka.Pipes.Types.PipeSourceDynamoDBStreamParameters" "amazonka-pipes-2.0-DDuNjbjVfgsJFLlibzr06i" 'False) (C1 ('MetaCons "PipeSourceDynamoDBStreamParameters'" '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 "startingPosition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DynamoDBStreamStartPosition)))))

newPipeSourceDynamoDBStreamParameters Source #

Arguments

:: DynamoDBStreamStartPosition	`$sel:startingPosition:PipeSourceDynamoDBStreamParameters'`
-> PipeSourceDynamoDBStreamParameters

Create a value of PipeSourceDynamoDBStreamParameters 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:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_batchSize - The maximum number of records to include in each batch.

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

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

$sel:maximumRecordAgeInSeconds:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_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:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_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:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_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:PipeSourceDynamoDBStreamParameters', pipeSourceDynamoDBStreamParameters_parallelizationFactor - (Streams only) The number of batches to process concurrently from each shard. The default value is 1.

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

pipeSourceDynamoDBStreamParameters_batchSize :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Natural) Source #

The maximum number of records to include in each batch.

pipeSourceDynamoDBStreamParameters_deadLetterConfig :: Lens' PipeSourceDynamoDBStreamParameters (Maybe DeadLetterConfig) Source #

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

pipeSourceDynamoDBStreamParameters_maximumBatchingWindowInSeconds :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Natural) Source #

The maximum length of a time to wait for events.

pipeSourceDynamoDBStreamParameters_maximumRecordAgeInSeconds :: Lens' PipeSourceDynamoDBStreamParameters (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.

pipeSourceDynamoDBStreamParameters_maximumRetryAttempts :: Lens' PipeSourceDynamoDBStreamParameters (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.

pipeSourceDynamoDBStreamParameters_onPartialBatchItemFailure :: Lens' PipeSourceDynamoDBStreamParameters (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.

pipeSourceDynamoDBStreamParameters_parallelizationFactor :: Lens' PipeSourceDynamoDBStreamParameters (Maybe Natural) Source #

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

pipeSourceDynamoDBStreamParameters_startingPosition :: Lens' PipeSourceDynamoDBStreamParameters DynamoDBStreamStartPosition Source #

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