AWS::MSK::Replicator ConsumerGroupReplication - AWS CloudFormation
SyntaxProperties

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

AWS::MSK::Replicator ConsumerGroupReplication

Details about consumer group replication.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "ConsumerGroupOffsetSyncMode" : String,
  "ConsumerGroupsToExclude" : [ String, ... ],
  "ConsumerGroupsToReplicate" : [ String, ... ],
  "DetectAndCopyNewConsumerGroups" : Boolean,
  "SynchroniseConsumerGroupOffsets" : Boolean
}

Properties

ConsumerGroupOffsetSyncMode

The consumer group offset synchronization mode. With LEGACY, offsets are synchronized when producers write to the source cluster. With ENHANCED, consumer offsets are synchronized regardless of producer location. ENHANCED requires a corresponding replicator that replicates data from the target cluster to the source cluster.

Required: No

Type: String

Allowed values: LEGACY | ENHANCED

Update requires: Replacement

ConsumerGroupsToExclude

List of regular expression patterns indicating the consumer groups that should not be replicated.

Required: No

Type: Array of String

Minimum: 1

Maximum: 256 | 100

Update requires: No interruption

ConsumerGroupsToReplicate

List of regular expression patterns indicating the consumer groups to copy.

Required: Yes

Type: Array of String

Minimum: 0

Maximum: 256 | 100

Update requires: No interruption

DetectAndCopyNewConsumerGroups

Enables synchronization of consumer groups to target cluster.

Required: No

Type: Boolean

Update requires: No interruption

SynchroniseConsumerGroupOffsets

Enables synchronization of consumer group offsets to target cluster. The translated offsets will be written to topic __consumer_offsets.

Required: No

Type: Boolean

Update requires: No interruption