aws-cdk-lib.aws_msk.CfnReplicator.ReplicationInfoProperty

ReplicationInfoProperty Struct

Specifies configuration for replication between a source and target Kafka cluster.

Source

Generated code

Type last changed

v2.251.0 · 24 Apr 2026

Example

// 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 replicationInfoProperty: msk.CfnReplicator.ReplicationInfoProperty = {
  consumerGroupReplication: {
    consumerGroupsToReplicate: ['consumerGroupsToReplicate'],

    // the properties below are optional
    consumerGroupOffsetSyncMode: 'consumerGroupOffsetSyncMode',
    consumerGroupsToExclude: ['consumerGroupsToExclude'],
    detectAndCopyNewConsumerGroups: false,
    synchroniseConsumerGroupOffsets: false,
  },
  targetCompressionType: 'targetCompressionType',
  topicReplication: {
    topicsToReplicate: ['topicsToReplicate'],

    // the properties below are optional
    copyAccessControlListsForTopics: false,
    copyTopicConfigurations: false,
    detectAndCopyNewTopics: false,
    startingPosition: {
      type: 'type',
    },
    topicNameConfiguration: {
      type: 'type',
    },
    topicsToExclude: ['topicsToExclude'],
  },

  // the properties below are optional
  sourceKafkaClusterArn: 'sourceKafkaClusterArn',
  sourceKafkaClusterId: 'sourceKafkaClusterId',
  targetKafkaClusterArn: 'targetKafkaClusterArn',
  targetKafkaClusterId: 'targetKafkaClusterId',
};

Properties

consumerGroupReplicationIResolvable | CfnReplicator.ConsumerGroupReplicationPropertyconsumer_group_replicationtyping.Union[IResolvable, ConsumerGroupReplicationProperty]consumerGroupReplicationIResolvableConsumerGroupReplicationIResolvableConsumerGroupReplicationinterface{}required#

Configuration relating to consumer group replication.

sourceKafkaClusterArnstringsource_kafka_cluster_arnstrsourceKafkaClusterArnStringSourceKafkaClusterArnstringSourceKafkaClusterArn*string#

The ARN of the source Kafka cluster.

sourceKafkaClusterIdstringsource_kafka_cluster_idstrsourceKafkaClusterIdStringSourceKafkaClusterIdstringSourceKafkaClusterId*string#

The ID of the source Kafka cluster.

targetCompressionTypestringtarget_compression_typestrtargetCompressionTypeStringTargetCompressionTypestringTargetCompressionType*stringrequired#

The compression type to use when producing records to target cluster.

targetKafkaClusterArnstringtarget_kafka_cluster_arnstrtargetKafkaClusterArnStringTargetKafkaClusterArnstringTargetKafkaClusterArn*string#

The ARN of the target Kafka cluster.

targetKafkaClusterIdstringtarget_kafka_cluster_idstrtargetKafkaClusterIdStringTargetKafkaClusterIdstringTargetKafkaClusterId*string#

The ID of the target Kafka cluster.

topicReplicationIResolvable | CfnReplicator.TopicReplicationPropertytopic_replicationtyping.Union[IResolvable, TopicReplicationProperty]topicReplicationIResolvableTopicReplicationIResolvableTopicReplicationinterface{}required#

Configuration relating to topic replication.