AWS::Pipes::Pipe PipeSourceManagedStreamingKafkaParameters - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

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
}

Properties

BatchSize

The maximum number of records to include in each batch.

Required: No

Type: Integer

Minimum: 1

Maximum: 10000

Update requires: No interruption

ConsumerGroupID

The name of the destination queue to consume.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9-\/*:_+=.@-]*$

Minimum: 1

Maximum: 200

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

Minimum: 0

Maximum: 300

Update requires: No interruption

StartingPosition

The position in a stream from which to start reading.

Required: No

Type: String

Allowed values: TRIM_HORIZON | LATEST

Update requires: Replacement

TopicName

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

Required: Yes

Type: String

Pattern: ^[^.]([a-zA-Z0-9\-_.]+)$

Minimum: 1

Maximum: 249

Update requires: Replacement