Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. msk
  5. getReplicator

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.msk.getReplicator

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::MSK::Replicator

    Using getReplicator

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getReplicator(args: GetReplicatorArgs, opts?: InvokeOptions): Promise<GetReplicatorResult>
function getReplicatorOutput(args: GetReplicatorOutputArgs, opts?: InvokeOptions): Output<GetReplicatorResult>
    def get_replicator(replicator_arn: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetReplicatorResult
def get_replicator_output(replicator_arn: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetReplicatorResult]
    func LookupReplicator(ctx *Context, args *LookupReplicatorArgs, opts ...InvokeOption) (*LookupReplicatorResult, error)
func LookupReplicatorOutput(ctx *Context, args *LookupReplicatorOutputArgs, opts ...InvokeOption) LookupReplicatorResultOutput

    > Note: This function is named LookupReplicator in the Go SDK.

    public static class GetReplicator 
{
    public static Task<GetReplicatorResult> InvokeAsync(GetReplicatorArgs args, InvokeOptions? opts = null)
    public static Output<GetReplicatorResult> Invoke(GetReplicatorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetReplicatorResult> getReplicator(GetReplicatorArgs args, InvokeOptions options)
public static Output<GetReplicatorResult> getReplicator(GetReplicatorArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:msk:getReplicator
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ReplicatorArn string
    Amazon Resource Name for the created replicator.
    ReplicatorArn string
    Amazon Resource Name for the created replicator.
    replicatorArn String
    Amazon Resource Name for the created replicator.
    replicatorArn string
    Amazon Resource Name for the created replicator.
    replicator_arn str
    Amazon Resource Name for the created replicator.
    replicatorArn String
    Amazon Resource Name for the created replicator.

    getReplicator Result

    The following output properties are available:

    CurrentVersion string
    The current version of the MSK replicator.
    ReplicationInfoList List<Pulumi.AwsNative.Msk.Outputs.ReplicatorReplicationInfo>
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    ReplicatorArn string
    Amazon Resource Name for the created replicator.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A collection of tags associated with a resource
    CurrentVersion string
    The current version of the MSK replicator.
    ReplicationInfoList []ReplicatorReplicationInfo
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    ReplicatorArn string
    Amazon Resource Name for the created replicator.
    Tags Tag
    A collection of tags associated with a resource
    currentVersion String
    The current version of the MSK replicator.
    replicationInfoList List<ReplicatorReplicationInfo>
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    replicatorArn String
    Amazon Resource Name for the created replicator.
    tags List<Tag>
    A collection of tags associated with a resource
    currentVersion string
    The current version of the MSK replicator.
    replicationInfoList ReplicatorReplicationInfo[]
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    replicatorArn string
    Amazon Resource Name for the created replicator.
    tags Tag[]
    A collection of tags associated with a resource
    current_version str
    The current version of the MSK replicator.
    replication_info_list Sequence[ReplicatorReplicationInfo]
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    replicator_arn str
    Amazon Resource Name for the created replicator.
    tags Sequence[root_Tag]
    A collection of tags associated with a resource
    currentVersion String
    The current version of the MSK replicator.
    replicationInfoList List<Property Map>
    A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
    replicatorArn String
    Amazon Resource Name for the created replicator.
    tags List<Property Map>
    A collection of tags associated with a resource

    Supporting Types

    ReplicatorConsumerGroupReplication

    ConsumerGroupsToReplicate List<string>
    List of regular expression patterns indicating the consumer groups to copy.
    ConsumerGroupsToExclude List<string>
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    DetectAndCopyNewConsumerGroups bool
    Whether to periodically check for new consumer groups.
    SynchroniseConsumerGroupOffsets bool
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    ConsumerGroupsToReplicate []string
    List of regular expression patterns indicating the consumer groups to copy.
    ConsumerGroupsToExclude []string
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    DetectAndCopyNewConsumerGroups bool
    Whether to periodically check for new consumer groups.
    SynchroniseConsumerGroupOffsets bool
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumerGroupsToReplicate List<String>
    List of regular expression patterns indicating the consumer groups to copy.
    consumerGroupsToExclude List<String>
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detectAndCopyNewConsumerGroups Boolean
    Whether to periodically check for new consumer groups.
    synchroniseConsumerGroupOffsets Boolean
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumerGroupsToReplicate string[]
    List of regular expression patterns indicating the consumer groups to copy.
    consumerGroupsToExclude string[]
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detectAndCopyNewConsumerGroups boolean
    Whether to periodically check for new consumer groups.
    synchroniseConsumerGroupOffsets boolean
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumer_groups_to_replicate Sequence[str]
    List of regular expression patterns indicating the consumer groups to copy.
    consumer_groups_to_exclude Sequence[str]
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detect_and_copy_new_consumer_groups bool
    Whether to periodically check for new consumer groups.
    synchronise_consumer_group_offsets bool
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.
    consumerGroupsToReplicate List<String>
    List of regular expression patterns indicating the consumer groups to copy.
    consumerGroupsToExclude List<String>
    List of regular expression patterns indicating the consumer groups that should not be replicated.
    detectAndCopyNewConsumerGroups Boolean
    Whether to periodically check for new consumer groups.
    synchroniseConsumerGroupOffsets Boolean
    Whether to periodically write the translated offsets to __consumer_offsets topic in target cluster.

    ReplicatorReplicationInfo

    ConsumerGroupReplication Pulumi.AwsNative.Msk.Inputs.ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    SourceKafkaClusterArn string
    Amazon Resource Name of the source Kafka cluster.
    TargetCompressionType Pulumi.AwsNative.Msk.ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    TargetKafkaClusterArn string
    Amazon Resource Name of the target Kafka cluster.
    TopicReplication Pulumi.AwsNative.Msk.Inputs.ReplicatorTopicReplication
    Configuration relating to topic replication.
    ConsumerGroupReplication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    SourceKafkaClusterArn string
    Amazon Resource Name of the source Kafka cluster.
    TargetCompressionType ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    TargetKafkaClusterArn string
    Amazon Resource Name of the target Kafka cluster.
    TopicReplication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumerGroupReplication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    sourceKafkaClusterArn String
    Amazon Resource Name of the source Kafka cluster.
    targetCompressionType ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    targetKafkaClusterArn String
    Amazon Resource Name of the target Kafka cluster.
    topicReplication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumerGroupReplication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    sourceKafkaClusterArn string
    Amazon Resource Name of the source Kafka cluster.
    targetCompressionType ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    targetKafkaClusterArn string
    Amazon Resource Name of the target Kafka cluster.
    topicReplication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumer_group_replication ReplicatorConsumerGroupReplication
    Configuration relating to consumer group replication.
    source_kafka_cluster_arn str
    Amazon Resource Name of the source Kafka cluster.
    target_compression_type ReplicatorReplicationInfoTargetCompressionType
    The type of compression to use writing records to target Kafka cluster.
    target_kafka_cluster_arn str
    Amazon Resource Name of the target Kafka cluster.
    topic_replication ReplicatorTopicReplication
    Configuration relating to topic replication.
    consumerGroupReplication Property Map
    Configuration relating to consumer group replication.
    sourceKafkaClusterArn String
    Amazon Resource Name of the source Kafka cluster.
    targetCompressionType "NONE" | "GZIP" | "SNAPPY" | "LZ4" | "ZSTD"
    The type of compression to use writing records to target Kafka cluster.
    targetKafkaClusterArn String
    Amazon Resource Name of the target Kafka cluster.
    topicReplication Property Map
    Configuration relating to topic replication.

    ReplicatorReplicationInfoTargetCompressionType

    ReplicatorReplicationStartingPosition

    Type ReplicatorReplicationStartingPositionType
    The type of replication starting position.
    type ReplicatorReplicationStartingPositionType
    The type of replication starting position.
    type ReplicatorReplicationStartingPositionType
    The type of replication starting position.
    type ReplicatorReplicationStartingPositionType
    The type of replication starting position.
    type "LATEST" | "EARLIEST"
    The type of replication starting position.

    ReplicatorReplicationStartingPositionType

    ReplicatorReplicationTopicNameConfiguration

    Type Pulumi.AwsNative.Msk.ReplicatorReplicationTopicNameConfigurationType
    The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
    Type ReplicatorReplicationTopicNameConfigurationType
    The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
    type ReplicatorReplicationTopicNameConfigurationType
    The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
    type ReplicatorReplicationTopicNameConfigurationType
    The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
    type ReplicatorReplicationTopicNameConfigurationType
    The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.
    type "PREFIXED_WITH_SOURCE_CLUSTER_ALIAS" | "IDENTICAL"
    The type of replication topic name configuration, identical to upstream topic name or prefixed with source cluster alias.

    ReplicatorReplicationTopicNameConfigurationType

    ReplicatorTopicReplication

    TopicsToReplicate List<string>
    List of regular expression patterns indicating the topics to copy.
    CopyAccessControlListsForTopics bool
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    CopyTopicConfigurations bool
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    DetectAndCopyNewTopics bool
    Whether to periodically check for new topics and partitions.
    StartingPosition Pulumi.AwsNative.Msk.Inputs.ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    TopicNameConfiguration Pulumi.AwsNative.Msk.Inputs.ReplicatorReplicationTopicNameConfiguration
    Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
    TopicsToExclude List<string>
    List of regular expression patterns indicating the topics that should not be replicated.
    TopicsToReplicate []string
    List of regular expression patterns indicating the topics to copy.
    CopyAccessControlListsForTopics bool
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    CopyTopicConfigurations bool
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    DetectAndCopyNewTopics bool
    Whether to periodically check for new topics and partitions.
    StartingPosition ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    TopicNameConfiguration ReplicatorReplicationTopicNameConfiguration
    Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
    TopicsToExclude []string
    List of regular expression patterns indicating the topics that should not be replicated.
    topicsToReplicate List<String>
    List of regular expression patterns indicating the topics to copy.
    copyAccessControlListsForTopics Boolean
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copyTopicConfigurations Boolean
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detectAndCopyNewTopics Boolean
    Whether to periodically check for new topics and partitions.
    startingPosition ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    topicNameConfiguration ReplicatorReplicationTopicNameConfiguration
    Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
    topicsToExclude List<String>
    List of regular expression patterns indicating the topics that should not be replicated.
    topicsToReplicate string[]
    List of regular expression patterns indicating the topics to copy.
    copyAccessControlListsForTopics boolean
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copyTopicConfigurations boolean
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detectAndCopyNewTopics boolean
    Whether to periodically check for new topics and partitions.
    startingPosition ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    topicNameConfiguration ReplicatorReplicationTopicNameConfiguration
    Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
    topicsToExclude string[]
    List of regular expression patterns indicating the topics that should not be replicated.
    topics_to_replicate Sequence[str]
    List of regular expression patterns indicating the topics to copy.
    copy_access_control_lists_for_topics bool
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copy_topic_configurations bool
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detect_and_copy_new_topics bool
    Whether to periodically check for new topics and partitions.
    starting_position ReplicatorReplicationStartingPosition
    Configuration for specifying the position in the topics to start replicating from.
    topic_name_configuration ReplicatorReplicationTopicNameConfiguration
    Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
    topics_to_exclude Sequence[str]
    List of regular expression patterns indicating the topics that should not be replicated.
    topicsToReplicate List<String>
    List of regular expression patterns indicating the topics to copy.
    copyAccessControlListsForTopics Boolean
    Whether to periodically configure remote topic ACLs to match their corresponding upstream topics.
    copyTopicConfigurations Boolean
    Whether to periodically configure remote topics to match their corresponding upstream topics.
    detectAndCopyNewTopics Boolean
    Whether to periodically check for new topics and partitions.
    startingPosition Property Map
    Configuration for specifying the position in the topics to start replicating from.
    topicNameConfiguration Property Map
    Configuration for specifying replicated topic names should be the same as their corresponding upstream topics or prefixed with source cluster alias.
    topicsToExclude List<String>
    List of regular expression patterns indicating the topics that should not be replicated.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.26.0 published on Wednesday, Mar 12, 2025 by Pulumi
    pulumi/pulumi-aws-native