Class: Aws::Kinesis::Types::DeadLetterConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::Kinesis::Types::DeadLetterConfiguration
- Defined in:
- gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb
Overview
The dead-letter handling configuration for a queue. Each queue has
built-in dead-letter handling. When a record has been received
MaxReceiveCount times without being acknowledged, it becomes a
dead-letter record, and ReceiveQueueRecords no longer returns it. The
dead-letter record stays in the same queue, and you work with it
through ReceiveDeadLetterQueueRecords,
AcknowledgeDeadLetterQueueRecords,
UpdateDeadLetterQueueRecordsVisibility, and
RestoreDeadLetterQueueRecords, which use the same queue ARN.
Dead-letter handling is enabled by default, with a MaxReceiveCount
of 6. To use a different value, or to turn dead-letter handling off,
specify this configuration in QueueAttributes.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#max_receive_count ⇒ Integer
The number of times a record can be received without being acknowledged before it becomes a dead-letter record.
-
#target_type ⇒ String
Whether dead-letter handling is enabled for the queue.
Instance Attribute Details
#max_receive_count ⇒ Integer
The number of times a record can be received without being
acknowledged before it becomes a dead-letter record. Required when
TargetType is BUILT_IN. A queue that you create without
DeadLetterConfiguration gets a MaxReceiveCount of 6.
880 881 882 883 884 885 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 880 class DeadLetterConfiguration < Struct.new( :target_type, :max_receive_count) SENSITIVE = [] include Aws::Structure end |
#target_type ⇒ String
Whether dead-letter handling is enabled for the queue. BUILT_IN
enables it: when a record has been received MaxReceiveCount times
without being acknowledged, it becomes a dead-letter record and
ReceiveQueueRecords no longer returns it. NONE disables it, and an
unacknowledged record continues to be redelivered until it is
acknowledged or its retention period ends.
880 881 882 883 884 885 |
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 880 class DeadLetterConfiguration < Struct.new( :target_type, :max_receive_count) SENSITIVE = [] include Aws::Structure end |