Class: Aws::Pipes::Types::PipeSourceSelfManagedKafkaParameters

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

Overview

The parameters for using a self-managed Apache Kafka stream as a source.

A *self managed* cluster refers to any Apache Kafka cluster not hosted by Amazon Web Services. This includes both clusters you manage yourself, as well as those hosted by a third-party provider, such as [Confluent Cloud], [CloudKarafka], or [Redpanda]. For more information, see [Apache Kafka streams as a source] in the *Amazon EventBridge User Guide*.

[1]: www.confluent.io/ [2]: www.cloudkarafka.com/ [3]: redpanda.com/ [4]: docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html

See Also:

Constant Summary collapse

SENSITIVE = 
[:topic_name, :additional_bootstrap_servers, :consumer_group_id]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_bootstrap_servers ⇒ Array<String>

An array of server URLs.

Returns:

  • (Array<String>) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#batch_size ⇒ Integer

The maximum number of records to include in each batch.

Returns:

  • (Integer) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#consumer_group_id ⇒ String

The name of the destination queue to consume.

Returns:

  • (String) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#credentials ⇒ Types::SelfManagedKafkaAccessConfigurationCredentials

The credentials needed to access the resource.

Returns:



2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

class PipeSourceSelfManagedKafkaParameters < Struct.new(
  :topic_name,
  :starting_position,
  :additional_bootstrap_servers,
  :batch_size,
  :maximum_batching_window_in_seconds,
  :consumer_group_id,
  :credentials,
  :server_root_ca_certificate,
  :vpc)
  SENSITIVE = [:topic_name, :additional_bootstrap_servers, :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) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#server_root_ca_certificate ⇒ String

The ARN of the Secrets Manager secret used for certification.

Returns:

  • (String) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#starting_position ⇒ String

The position in a stream from which to start reading.

Returns:

  • (String) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#topic_name ⇒ String

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

Returns:

  • (String) 


2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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

#vpc ⇒ Types::SelfManagedKafkaAccessConfigurationVpc

This structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.

Returns:



2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
 
# File 'lib/aws-sdk-pipes/types.rb', line 2053

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