AWS::Pipes::Pipe PipeSourceSelfManagedKafkaParameters
The parameters for using a self-managed Apache Kafka stream as a source.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AdditionalBootstrapServers" :[ String, ... ], "BatchSize" :Integer, "ConsumerGroupID" :String, "Credentials" :SelfManagedKafkaAccessConfigurationCredentials, "MaximumBatchingWindowInSeconds" :Integer, "ServerRootCaCertificate" :String, "StartingPosition" :String, "TopicName" :String, "Vpc" :SelfManagedKafkaAccessConfigurationVpc}
YAML
AdditionalBootstrapServers:- StringBatchSize:IntegerConsumerGroupID:StringCredentials:SelfManagedKafkaAccessConfigurationCredentialsMaximumBatchingWindowInSeconds:IntegerServerRootCaCertificate:StringStartingPosition:StringTopicName:StringVpc:SelfManagedKafkaAccessConfigurationVpc
Properties
AdditionalBootstrapServers-
An array of server URLs.
Required: No
Type: List of String
Update requires: No interruption
BatchSizeThe maximum number of records to include in each batch.
Required: No
Type: Integer
Update requires: No interruption
ConsumerGroupIDThe name of the destination queue to consume.
Required: No
Type: String
Update requires: No interruption
CredentialsThe credentials needed to access the resource.
Required: No
Type: SelfManagedKafkaAccessConfigurationCredentials
Update requires: No interruption
MaximumBatchingWindowInSecondsThe maximum length of a time to wait for events.
Required: No
Type: Integer
Update requires: No interruption
ServerRootCaCertificateThe ARN of the Secrets Manager secret used for certification.
Required: No
Type: String
Update requires: No interruption
StartingPosition(Streams only) The position in a stream from which to start reading.
Required: No
Type: String
Update requires: No interruption
TopicNameThe name of the topic that the pipe will read from.
Required: Yes
Type: String
Update requires: No interruption
VpcThis structure specifies the VPC subnets and security groups for the stream, and whether a public IP address is to be used.
Required: No
Type: SelfManagedKafkaAccessConfigurationVpc
Update requires: No interruption