Class: Aws::Pipes::Types::PipeSourceKinesisStreamParameters
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pipes::Types::PipeSourceKinesisStreamParameters
- Defined in:
- gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb
Overview
The parameters for using a Kinesis stream as a source.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#batch_size ⇒ Integer
The maximum number of records to include in each batch.
-
#dead_letter_config ⇒ Types::DeadLetterConfig
Define the target queue to send dead-letter queue events to.
-
#maximum_batching_window_in_seconds ⇒ Integer
The maximum length of a time to wait for events.
-
#maximum_record_age_in_seconds ⇒ Integer
(Streams only) Discard records older than the specified age.
-
#maximum_retry_attempts ⇒ Integer
(Streams only) Discard records after the specified number of retries.
-
#on_partial_batch_item_failure ⇒ String
(Streams only) Define how to handle item process failures.
-
#parallelization_factor ⇒ Integer
(Streams only) The number of batches to process concurrently from each shard.
-
#starting_position ⇒ String
(Streams only) The position in a stream from which to start reading.
-
#starting_position_timestamp ⇒ Time
With
StartingPosition
set toAT_TIMESTAMP
, the time from which to start reading, in Unix time seconds.
Instance Attribute Details
#batch_size ⇒ Integer
The maximum number of records to include in each batch.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#dead_letter_config ⇒ Types::DeadLetterConfig
Define the target queue to send dead-letter queue events to.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#maximum_batching_window_in_seconds ⇒ Integer
The maximum length of a time to wait for events.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#maximum_record_age_in_seconds ⇒ Integer
(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.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#maximum_retry_attempts ⇒ Integer
(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.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#on_partial_batch_item_failure ⇒ String
(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.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#parallelization_factor ⇒ Integer
(Streams only) The number of batches to process concurrently from each shard. The default value is 1.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#starting_position ⇒ String
(Streams only) The position in a stream from which to start reading.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |
#starting_position_timestamp ⇒ Time
With StartingPosition
set to AT_TIMESTAMP
, the time from which
to start reading, in Unix time seconds.
1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 |
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1728 class PipeSourceKinesisStreamParameters < Struct.new( :batch_size, :dead_letter_config, :maximum_batching_window_in_seconds, :maximum_record_age_in_seconds, :maximum_retry_attempts, :on_partial_batch_item_failure, :parallelization_factor, :starting_position, :starting_position_timestamp) SENSITIVE = [] include Aws::Structure end |