Struct PipeSourceSelfManagedKafkaParameters

#[non_exhaustive]
pub struct PipeSourceSelfManagedKafkaParameters {
    pub topic_name: String,
    pub starting_position: Option<SelfManagedKafkaStartPosition>,
    pub additional_bootstrap_servers: Option<Vec<String>>,
    pub batch_size: Option<i32>,
    pub maximum_batching_window_in_seconds: Option<i32>,
    pub consumer_group_id: Option<String>,
    pub credentials: Option<SelfManagedKafkaAccessConfigurationCredentials>,
    pub server_root_ca_certificate: Option<String>,
    pub vpc: Option<SelfManagedKafkaAccessConfigurationVpc>,
}

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

topic_name: String

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

starting_position: Option<SelfManagedKafkaStartPosition>

The position in a stream from which to start reading.

additional_bootstrap_servers: Option<Vec<String>>

An array of server URLs.

batch_size: Option<i32>

The maximum number of records to include in each batch.

maximum_batching_window_in_seconds: Option<i32>

The maximum length of a time to wait for events.

consumer_group_id: Option<String>

The name of the destination queue to consume.

credentials: Option<SelfManagedKafkaAccessConfigurationCredentials>

The credentials needed to access the resource.

server_root_ca_certificate: Option<String>

The ARN of the Secrets Manager secret used for certification.

vpc: Option<SelfManagedKafkaAccessConfigurationVpc>

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

Implementations

impl PipeSourceSelfManagedKafkaParameters

pub fn topic_name(&self) -> &str

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

pub fn starting_position(&self) -> Option<&SelfManagedKafkaStartPosition>

The position in a stream from which to start reading.

pub fn additional_bootstrap_servers(&self) -> &[String]

An array of server URLs.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .additional_bootstrap_servers.is_none().

pub fn batch_size(&self) -> Option<i32>

The maximum number of records to include in each batch.

pub fn maximum_batching_window_in_seconds(&self) -> Option<i32>

The maximum length of a time to wait for events.

pub fn consumer_group_id(&self) -> Option<&str>

The name of the destination queue to consume.

pub fn credentials( &self, ) -> Option<&SelfManagedKafkaAccessConfigurationCredentials>

The credentials needed to access the resource.

pub fn server_root_ca_certificate(&self) -> Option<&str>

The ARN of the Secrets Manager secret used for certification.

pub fn vpc(&self) -> Option<&SelfManagedKafkaAccessConfigurationVpc>

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

impl PipeSourceSelfManagedKafkaParameters

pub fn builder() -> PipeSourceSelfManagedKafkaParametersBuilder

Creates a new builder-style object to manufacture PipeSourceSelfManagedKafkaParameters.

Trait Implementations

impl Clone for PipeSourceSelfManagedKafkaParameters

fn clone(&self) -> PipeSourceSelfManagedKafkaParameters

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PipeSourceSelfManagedKafkaParameters

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for PipeSourceSelfManagedKafkaParameters

fn eq(&self, other: &PipeSourceSelfManagedKafkaParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PipeSourceSelfManagedKafkaParameters