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

Description

Synopsis

Documentation

data UpdatePipeSourceKinesisStreamParameters Source #

The parameters for using a Kinesis stream as a source.

See: newUpdatePipeSourceKinesisStreamParameters smart constructor.

Constructors

UpdatePipeSourceKinesisStreamParameters'

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.

Instances

Instances details

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

newUpdatePipeSourceKinesisStreamParameters :: UpdatePipeSourceKinesisStreamParameters Source #

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

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

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

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

updatePipeSourceKinesisStreamParameters_batchSize :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Natural) Source #

The maximum number of records to include in each batch.

updatePipeSourceKinesisStreamParameters_deadLetterConfig :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe DeadLetterConfig) Source #

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

updatePipeSourceKinesisStreamParameters_maximumBatchingWindowInSeconds :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Natural) Source #

The maximum length of a time to wait for events.

updatePipeSourceKinesisStreamParameters_maximumRecordAgeInSeconds :: Lens' UpdatePipeSourceKinesisStreamParameters (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.

updatePipeSourceKinesisStreamParameters_maximumRetryAttempts :: Lens' UpdatePipeSourceKinesisStreamParameters (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.

updatePipeSourceKinesisStreamParameters_onPartialBatchItemFailure :: Lens' UpdatePipeSourceKinesisStreamParameters (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.

updatePipeSourceKinesisStreamParameters_parallelizationFactor :: Lens' UpdatePipeSourceKinesisStreamParameters (Maybe Natural) Source #

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