AWS::Pipes::Pipe PipeSourceManagedStreamingKafkaParameters
The parameters for using an MSK stream as a source.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "BatchSize" :
Integer
, "ConsumerGroupID" :String
, "Credentials" :MSKAccessCredentials
, "MaximumBatchingWindowInSeconds" :Integer
, "StartingPosition" :String
, "TopicName" :String
}
YAML
BatchSize:
Integer
ConsumerGroupID:String
Credentials:MSKAccessCredentials
MaximumBatchingWindowInSeconds:Integer
StartingPosition:String
TopicName:String
Properties
BatchSize
The maximum number of records to include in each batch.
Required: No
Type: Integer
Update requires: No interruption
ConsumerGroupID
The name of the destination queue to consume.
Required: No
Type: String
Update requires: Replacement
Credentials
The credentials needed to access the resource.
Required: No
Type: MSKAccessCredentials
Update requires: No interruption
MaximumBatchingWindowInSeconds
The maximum length of a time to wait for events.
Required: No
Type: Integer
Update requires: No interruption
StartingPosition
(Streams only) The position in a stream from which to start reading.
Required: No
Type: String
Update requires: Replacement
TopicName
The name of the topic that the pipe will read from.
Required: Yes
Type: String
Update requires: Replacement