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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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

  Discard records older than the specified age.

• #maximum_retry_attempts ⇒ Integer

  Discard records after the specified number of retries.

• #on_partial_batch_item_failure ⇒ String

  Define how to handle item process failures.

• #parallelization_factor ⇒ Integer

  The number of batches to process concurrently from each shard.

• #starting_position ⇒ String

  The position in a stream from which to start reading.

• #starting_position_timestamp ⇒ Time

  With StartingPosition set to AT_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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :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.

Returns:

• (Types::DeadLetterConfig)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_record_age_in_seconds ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#maximum_retry_attempts ⇒ Integer

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.

Returns:

• (Integer)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#on_partial_batch_item_failure ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#parallelization_factor ⇒ Integer

The number of batches to process concurrently from each shard. The default value is 1.

Returns:

• (Integer)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#starting_position ⇒ String

The position in a stream from which to start reading.

Returns:

• (String)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :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.

Returns:

• (Time)

# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1836

class PipeSourceKinesisStreamParameters < Struct.new(
  :batch_size,
  :dead_letter_config,
  :on_partial_batch_item_failure,
  :maximum_batching_window_in_seconds,
  :maximum_record_age_in_seconds,
  :maximum_retry_attempts,
  :parallelization_factor,
  :starting_position,
  :starting_position_timestamp)
  SENSITIVE = []
  include Aws::Structure
end