CfnReplicatorProps Struct
Properties for defining a CfnReplicator.
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 cfnReplicatorProps: msk.CfnReplicatorProps = {
kafkaClusters: [{
amazonMskCluster: {
mskClusterArn: 'mskClusterArn',
},
apacheKafkaCluster: {
apacheKafkaClusterId: 'apacheKafkaClusterId',
bootstrapBrokerString: 'bootstrapBrokerString',
},
clientAuthentication: {
mtls: {
secretArn: 'secretArn',
},
saslOAuthBearer: {
tokenEndpointAuthenticationMethod: 'tokenEndpointAuthenticationMethod',
tokenEndpointUrl: 'tokenEndpointUrl',
// the properties below are optional
clientCredentials: {
tokenRequestSecretArn: 'tokenRequestSecretArn',
},
clientCredentialsAssertion: {
audience: 'audience',
signingAlgorithm: 'signingAlgorithm',
// the properties below are optional
tokenRequestSecretArn: 'tokenRequestSecretArn',
},
iamJwtBearer: {
audience: 'audience',
signingAlgorithm: 'signingAlgorithm',
// the properties below are optional
tokenRequestSecretArn: 'tokenRequestSecretArn',
},
scope: 'scope',
tokenEndpointTlsCertificateArn: 'tokenEndpointTlsCertificateArn',
},
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
A summary description of the replicator.
kafkaClustersIResolvable | IResolvable | CfnReplicator.KafkaClusterProperty[]kafka_clusterstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, KafkaClusterProperty]]]kafkaClustersIResolvableKafkaClustersIResolvableKafkaClustersinterface{}required#Kafka Clusters to use in setting up sources / targets for replication.
logDeliveryIResolvable | CfnReplicator.LogDeliveryPropertylog_deliverytyping.Union[IResolvable, LogDeliveryProperty]logDeliveryIResolvableLogDeliveryIResolvableLogDeliveryinterface{}#Configuration for log delivery for the replicator.
replicationInfoListIResolvable | IResolvable | CfnReplicator.ReplicationInfoProperty[]replication_info_listtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ReplicationInfoProperty]]]replicationInfoListIResolvableReplicationInfoListIResolvableReplicationInfoListinterface{}required#A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
replicatorNamestringreplicator_namestrreplicatorNameStringReplicatorNamestringReplicatorName*stringrequired#The name of the replicator.
Alpha-numeric characters with '-' are allowed.
serviceExecutionRoleArnstringservice_execution_role_arnstrserviceExecutionRoleArnStringServiceExecutionRoleArnstringServiceExecutionRoleArn*stringrequired#The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).