Class: Aws::Pipes::Types::PipeSourceManagedStreamingKafkaParameters

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb

Overview

The parameters for using an MSK stream as a source.

See Also:

Constant Summary collapse

SENSITIVE = 
[:topic_name, :consumer_group_id]

Instance Attribute Summary collapse

Instance Attribute Details

#batch_size ⇒ Integer

The maximum number of records to include in each batch.

Returns:

  • (Integer) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1884

class PipeSourceManagedStreamingKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials)
  SENSITIVE = [:topic_name, :consumer_group_id]
  include Aws::Structure
end

#consumer_group_id ⇒ String

The name of the destination queue to consume.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1884

class PipeSourceManagedStreamingKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials)
  SENSITIVE = [:topic_name, :consumer_group_id]
  include Aws::Structure
end

#credentials ⇒ Types::MSKAccessCredentials

The credentials needed to access the resource.

Returns:



1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1884

class PipeSourceManagedStreamingKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials)
  SENSITIVE = [:topic_name, :consumer_group_id]
  include Aws::Structure
end

#maximum_batching_window_in_seconds ⇒ Integer

The maximum length of a time to wait for events.

Returns:

  • (Integer) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1884

class PipeSourceManagedStreamingKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials)
  SENSITIVE = [:topic_name, :consumer_group_id]
  include Aws::Structure
end

#starting_position ⇒ String

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

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1884

class PipeSourceManagedStreamingKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials)
  SENSITIVE = [:topic_name, :consumer_group_id]
  include Aws::Structure
end

#topic_name ⇒ String

The name of the topic that the pipe will read from.

Returns:

  • (String) 


1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
 
# File 'gems/aws-sdk-pipes/lib/aws-sdk-pipes/types.rb', line 1884

class PipeSourceManagedStreamingKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials)
  SENSITIVE = [:topic_name, :consumer_group_id]
  include Aws::Structure
end