interface CfnReplicatorProps

Language	Type name
.NET	`Amazon.CDK.AWS.MSK.CfnReplicatorProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmsk#CfnReplicatorProps`
Java	`software.amazon.awscdk.services.msk.CfnReplicatorProps`
Python	`aws_cdk.aws_msk.CfnReplicatorProps`
TypeScript	`aws-cdk-lib` » `aws_msk` » `CfnReplicatorProps`

Properties for defining a CfnReplicator.

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 cfnReplicatorProps: msk.CfnReplicatorProps = {
  kafkaClusters: [{
    amazonMskCluster: {
      mskClusterArn: 'mskClusterArn',
    },
    apacheKafkaCluster: {
      apacheKafkaClusterId: 'apacheKafkaClusterId',
      bootstrapBrokerString: 'bootstrapBrokerString',
    },
    clientAuthentication: {
      saslScram: {
        mechanism: 'mechanism',
        secretArn: 'secretArn',
      },
    },
    encryptionInTransit: {
      encryptionType: 'encryptionType',

      // the properties below are optional
      rootCaCertificate: 'rootCaCertificate',
    },
    vpcConfig: {
      subnetIds: ['subnetIds'],

      // the properties below are optional
      securityGroupIds: ['securityGroupIds'],
    },
  }],
  replicationInfoList: [{
    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',
  }],
  replicatorName: 'replicatorName',
  serviceExecutionRoleArn: 'serviceExecutionRoleArn',

  // the properties below are optional
  description: 'description',
  logDelivery: {
    replicatorLogDelivery: {
      cloudWatchLogs: {
        enabled: false,

        // the properties below are optional
        logGroup: 'logGroup',
      },
      firehose: {
        enabled: false,

        // the properties below are optional
        deliveryStream: 'deliveryStream',
      },
      s3: {
        enabled: false,

        // the properties below are optional
        bucket: 'bucket',
        prefix: 'prefix',
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
kafkaClusters	`IResolvable` `\| (IResolvable` `\|` `KafkaClusterProperty)[]`	Kafka Clusters to use in setting up sources / targets for replication.
replicationInfoList	`IResolvable` `\| (IResolvable` `\|` `ReplicationInfoProperty)[]`	A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
replicatorName	`string`	The name of the replicator.
serviceExecutionRoleArn	`string`	The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).
description?	`string`	A summary description of the replicator.
logDelivery?	`IResolvable` `\|` `LogDeliveryProperty`	Configuration for log delivery for the replicator.
tags?	`CfnTag[]`	List of tags to attach to created Replicator.

kafkaClusters

Type: IResolvable | (IResolvable | KafkaClusterProperty)[]

Kafka Clusters to use in setting up sources / targets for replication.

replicationInfoList

Type: IResolvable | (IResolvable | ReplicationInfoProperty)[]

A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

replicatorName

Type: string

The name of the replicator.

Alpha-numeric characters with '-' are allowed.

serviceExecutionRoleArn

Type: string

The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).

description?

Type: string (optional)

A summary description of the replicator.

logDelivery?

Type: IResolvable | LogDeliveryProperty (optional)

Configuration for log delivery for the replicator.

tags?

Type: CfnTag[] (optional)

List of tags to attach to created Replicator.

AWS CDK

2.257.0