CfnReplicatorProps
- class aws_cdk.aws_msk.CfnReplicatorProps(*, kafka_clusters, replication_info_list, replicator_name, service_execution_role_arn, description=None, tags=None)
Bases:
objectProperties for defining a
CfnReplicator.- Parameters:
kafka_clusters (
Union[IResolvable,Sequence[Union[IResolvable,KafkaClusterProperty,Dict[str,Any]]]]) – Kafka Clusters to use in setting up sources / targets for replication.replication_info_list (
Union[IResolvable,Sequence[Union[IResolvable,ReplicationInfoProperty,Dict[str,Any]]]]) – A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.replicator_name (
str) – The name of the replicator. Alpha-numeric characters with ‘-’ are allowed.service_execution_role_arn (
str) – 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 (
Optional[str]) – A summary description of the replicator.tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – List of tags to attach to created Replicator.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_msk as msk cfn_replicator_props = msk.CfnReplicatorProps( kafka_clusters=[msk.CfnReplicator.KafkaClusterProperty( amazon_msk_cluster=msk.CfnReplicator.AmazonMskClusterProperty( msk_cluster_arn="mskClusterArn" ), vpc_config=msk.CfnReplicator.KafkaClusterClientVpcConfigProperty( subnet_ids=["subnetIds"], # the properties below are optional security_group_ids=["securityGroupIds"] ) )], replication_info_list=[msk.CfnReplicator.ReplicationInfoProperty( consumer_group_replication=msk.CfnReplicator.ConsumerGroupReplicationProperty( consumer_groups_to_replicate=["consumerGroupsToReplicate"], # the properties below are optional consumer_groups_to_exclude=["consumerGroupsToExclude"], detect_and_copy_new_consumer_groups=False, synchronise_consumer_group_offsets=False ), source_kafka_cluster_arn="sourceKafkaClusterArn", target_compression_type="targetCompressionType", target_kafka_cluster_arn="targetKafkaClusterArn", topic_replication=msk.CfnReplicator.TopicReplicationProperty( topics_to_replicate=["topicsToReplicate"], # the properties below are optional copy_access_control_lists_for_topics=False, copy_topic_configurations=False, detect_and_copy_new_topics=False, starting_position=msk.CfnReplicator.ReplicationStartingPositionProperty( type="type" ), topic_name_configuration=msk.CfnReplicator.ReplicationTopicNameConfigurationProperty( type="type" ), topics_to_exclude=["topicsToExclude"] ) )], replicator_name="replicatorName", service_execution_role_arn="serviceExecutionRoleArn", # the properties below are optional description="description", tags=[CfnTag( key="key", value="value" )] )
Attributes
- description
A summary description of the replicator.
- kafka_clusters
Kafka Clusters to use in setting up sources / targets for replication.
- replication_info_list
A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
- replicator_name
The name of the replicator.
Alpha-numeric characters with ‘-’ are allowed.
- service_execution_role_arn
The ARN of the IAM role used by the replicator to access resources in the customer’s account (e.g source and target clusters).
- tags
List of tags to attach to created Replicator.