UpdatePipeSourceSelfManagedKafkaParameters - Amazon EventBridge Pipes
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

UpdatePipeSourceSelfManagedKafkaParameters

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 AWS. 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.

Contents

BatchSize

The maximum number of records to include in each batch.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 10000.

Required: No

Credentials

The credentials needed to access the resource.

Type: SelfManagedKafkaAccessConfigurationCredentials object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: No

MaximumBatchingWindowInSeconds

The maximum length of a time to wait for events.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 300.

Required: No

ServerRootCaCertificate

The ARN of the Secrets Manager secret used for certification.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1600.

Pattern: (^arn:aws([a-z]|\-)*:secretsmanager:([a-z]{2,4}((-gov)|(-de)|(-iso([a-z]?)))?-[a-z]+(-\d{1})?):(\d{12}):secret:.+)

Required: No

Vpc

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

Type: SelfManagedKafkaAccessConfigurationVpc object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: