Package software.amazon.awscdk.services.msk

Class CfnReplicator

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.msk.CfnReplicator
All Implemented Interfaces:
IInspectable, ITaggableV2, IReplicatorRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:43.870Z") @Stability(Stable) public class CfnReplicator extends CfnResource implements IInspectable, IReplicatorRef, ITaggableV2
Creates the replicator.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.msk.*;
 CfnReplicator cfnReplicator = CfnReplicator.Builder.create(this, "MyCfnReplicator")
         .kafkaClusters(List.of(KafkaClusterProperty.builder()
                 .amazonMskCluster(AmazonMskClusterProperty.builder()
                         .mskClusterArn("mskClusterArn")
                         .build())
                 .vpcConfig(KafkaClusterClientVpcConfigProperty.builder()
                         .subnetIds(List.of("subnetIds"))
                         // the properties below are optional
                         .securityGroupIds(List.of("securityGroupIds"))
                         .build())
                 .build()))
         .replicationInfoList(List.of(ReplicationInfoProperty.builder()
                 .consumerGroupReplication(ConsumerGroupReplicationProperty.builder()
                         .consumerGroupsToReplicate(List.of("consumerGroupsToReplicate"))
                         // the properties below are optional
                         .consumerGroupsToExclude(List.of("consumerGroupsToExclude"))
                         .detectAndCopyNewConsumerGroups(false)
                         .synchroniseConsumerGroupOffsets(false)
                         .build())
                 .sourceKafkaClusterArn("sourceKafkaClusterArn")
                 .targetCompressionType("targetCompressionType")
                 .targetKafkaClusterArn("targetKafkaClusterArn")
                 .topicReplication(TopicReplicationProperty.builder()
                         .topicsToReplicate(List.of("topicsToReplicate"))
                         // the properties below are optional
                         .copyAccessControlListsForTopics(false)
                         .copyTopicConfigurations(false)
                         .detectAndCopyNewTopics(false)
                         .startingPosition(ReplicationStartingPositionProperty.builder()
                                 .type("type")
                                 .build())
                         .topicNameConfiguration(ReplicationTopicNameConfigurationProperty.builder()
                                 .type("type")
                                 .build())
                         .topicsToExclude(List.of("topicsToExclude"))
                         .build())
                 .build()))
         .replicatorName("replicatorName")
         .serviceExecutionRoleArn("serviceExecutionRoleArn")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnReplicator

      protected CfnReplicator(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnReplicator

      protected CfnReplicator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnReplicator

      @Stability(Stable) public CfnReplicator(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnReplicatorProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCurrentVersion

      @Stability(Stable) @NotNull public String getAttrCurrentVersion()
      The current version number of the replicator.

    • getAttrReplicatorArn

      @Stability(Stable) @NotNull public String getAttrReplicatorArn()
      Amazon Resource Name (ARN) for the created replicator.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getReplicatorRef

      @Stability(Stable) @NotNull public ReplicatorReference getReplicatorRef()
      A reference to a Replicator resource.
      Specified by:
      getReplicatorRef in interface IReplicatorRef

    • getKafkaClusters

      @Stability(Stable) @NotNull public Object getKafkaClusters()
      Kafka Clusters to use in setting up sources / targets for replication.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnReplicator.KafkaClusterProperty>

    • setKafkaClusters

      @Stability(Stable) public void setKafkaClusters(@NotNull IResolvable value)
      Kafka Clusters to use in setting up sources / targets for replication.

    • setKafkaClusters

      @Stability(Stable) public void setKafkaClusters(@NotNull List<Object> value)
      Kafka Clusters to use in setting up sources / targets for replication.

    • getReplicationInfoList

      @Stability(Stable) @NotNull public Object getReplicationInfoList()
      A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnReplicator.ReplicationInfoProperty>

    • setReplicationInfoList

      @Stability(Stable) public void setReplicationInfoList(@NotNull IResolvable value)
      A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

    • setReplicationInfoList

      @Stability(Stable) public void setReplicationInfoList(@NotNull List<Object> value)
      A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.

    • getReplicatorName

      @Stability(Stable) @NotNull public String getReplicatorName()
      The name of the replicator.

    • setReplicatorName

      @Stability(Stable) public void setReplicatorName(@NotNull String value)
      The name of the replicator.

    • getServiceExecutionRoleArn

      @Stability(Stable) @NotNull public String getServiceExecutionRoleArn()
      The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).

    • setServiceExecutionRoleArn

      @Stability(Stable) public void setServiceExecutionRoleArn(@NotNull String value)
      The ARN of the IAM role used by the replicator to access resources in the customer's account (e.g source and target clusters).

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A summary description of the replicator.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A summary description of the replicator.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      List of tags to attach to created Replicator.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      List of tags to attach to created Replicator.