Skip to content
v2.275.0

ConsumerGroupReplicationProperty Struct ​

Details about consumer group replication.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const consumerGroupReplicationProperty: msk.CfnReplicator.ConsumerGroupReplicationProperty = {
  consumerGroupsToReplicate: ['consumerGroupsToReplicate'],

  // the properties below are optional
  consumerGroupOffsetSyncMode: 'consumerGroupOffsetSyncMode',
  consumerGroupsToExclude: ['consumerGroupsToExclude'],
  detectAndCopyNewConsumerGroups: false,
  synchroniseConsumerGroupOffsets: false,
};

Properties ​

consumerGroupOffsetSyncModeoptionalstringconsumer_group_offset_sync_modeoptionalstrconsumerGroupOffsetSyncModeoptionalStringConsumerGroupOffsetSyncModeoptionalstringConsumerGroupOffsetSyncModeoptional*string#
The consumer group offset synchronization mode.
consumerGroupsToExcludeoptionalstring[]consumer_groups_to_excludeoptionaltyping.List[str]consumerGroupsToExcludeoptionalList<String>ConsumerGroupsToExcludeoptionalstring[]ConsumerGroupsToExcludeoptional*[]*string#
List of regular expression patterns indicating the consumer groups that should not be replicated.
consumerGroupsToReplicatestring[]consumer_groups_to_replicatetyping.List[str]consumerGroupsToReplicateList<String>ConsumerGroupsToReplicatestring[]ConsumerGroupsToReplicate*[]*stringrequired#
List of regular expression patterns indicating the consumer groups to copy.
detectAndCopyNewConsumerGroupsoptionalboolean | IResolvabledetect_and_copy_new_consumer_groupsoptionaltyping.Union[bool, IResolvable]detectAndCopyNewConsumerGroupsoptionalBooleanDetectAndCopyNewConsumerGroupsoptionalboolDetectAndCopyNewConsumerGroupsoptionalinterface{}#
Enables synchronization of consumer groups to target cluster.
synchroniseConsumerGroupOffsetsoptionalboolean | IResolvablesynchronise_consumer_group_offsetsoptionaltyping.Union[bool, IResolvable]synchroniseConsumerGroupOffsetsoptionalBooleanSynchroniseConsumerGroupOffsetsoptionalboolSynchroniseConsumerGroupOffsetsoptionalinterface{}#
Enables synchronization of consumer group offsets to target cluster.

The translated offsets will be written to topic __consumer_offsets.