Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aiven Provider
  3. API Docs
  4. getMirrorMakerReplicationFlow
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

aiven.getMirrorMakerReplicationFlow

Explore with Pulumi AI

aiven logo
Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
pulumi/pulumi-aiven

    Gets information about an Aiven for Apache Kafka® MirrorMaker 2 replication flow.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const exampleReplicationFlow = aiven.getMirrorMakerReplicationFlow({
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
    sourceCluster: source.serviceName,
    targetCluster: target.serviceName,
});

    import pulumi
import pulumi_aiven as aiven

example_replication_flow = aiven.get_mirror_maker_replication_flow(project=example_project["project"],
    service_name=example_kafka["serviceName"],
    source_cluster=source["serviceName"],
    target_cluster=target["serviceName"])

    package main

import (
	"github.com/pulumi/pulumi-aiven/sdk/v6/go/aiven"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aiven.LookupMirrorMakerReplicationFlow(ctx, &aiven.LookupMirrorMakerReplicationFlowArgs{
			Project:       exampleProject.Project,
			ServiceName:   exampleKafka.ServiceName,
			SourceCluster: source.ServiceName,
			TargetCluster: target.ServiceName,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleReplicationFlow = Aiven.GetMirrorMakerReplicationFlow.Invoke(new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
        SourceCluster = source.ServiceName,
        TargetCluster = target.ServiceName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.AivenFunctions;
import com.pulumi.aiven.inputs.GetMirrorMakerReplicationFlowArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var exampleReplicationFlow = AivenFunctions.getMirrorMakerReplicationFlow(GetMirrorMakerReplicationFlowArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .sourceCluster(source.serviceName())
            .targetCluster(target.serviceName())
            .build());

    }
}

    variables:
  exampleReplicationFlow:
    fn::invoke:
      function: aiven:getMirrorMakerReplicationFlow
      arguments:
        project: ${exampleProject.project}
        serviceName: ${exampleKafka.serviceName}
        sourceCluster: ${source.serviceName}
        targetCluster: ${target.serviceName}

    Using getMirrorMakerReplicationFlow

    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 getMirrorMakerReplicationFlow(args: GetMirrorMakerReplicationFlowArgs, opts?: InvokeOptions): Promise<GetMirrorMakerReplicationFlowResult>
function getMirrorMakerReplicationFlowOutput(args: GetMirrorMakerReplicationFlowOutputArgs, opts?: InvokeOptions): Output<GetMirrorMakerReplicationFlowResult>
    def get_mirror_maker_replication_flow(project: Optional[str] = None,
                                      service_name: Optional[str] = None,
                                      source_cluster: Optional[str] = None,
                                      target_cluster: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetMirrorMakerReplicationFlowResult
def get_mirror_maker_replication_flow_output(project: Optional[pulumi.Input[str]] = None,
                                      service_name: Optional[pulumi.Input[str]] = None,
                                      source_cluster: Optional[pulumi.Input[str]] = None,
                                      target_cluster: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetMirrorMakerReplicationFlowResult]
    func LookupMirrorMakerReplicationFlow(ctx *Context, args *LookupMirrorMakerReplicationFlowArgs, opts ...InvokeOption) (*LookupMirrorMakerReplicationFlowResult, error)
func LookupMirrorMakerReplicationFlowOutput(ctx *Context, args *LookupMirrorMakerReplicationFlowOutputArgs, opts ...InvokeOption) LookupMirrorMakerReplicationFlowResultOutput

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

    public static class GetMirrorMakerReplicationFlow 
{
    public static Task<GetMirrorMakerReplicationFlowResult> InvokeAsync(GetMirrorMakerReplicationFlowArgs args, InvokeOptions? opts = null)
    public static Output<GetMirrorMakerReplicationFlowResult> Invoke(GetMirrorMakerReplicationFlowInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetMirrorMakerReplicationFlowResult> getMirrorMakerReplicationFlow(GetMirrorMakerReplicationFlowArgs args, InvokeOptions options)
public static Output<GetMirrorMakerReplicationFlowResult> getMirrorMakerReplicationFlow(GetMirrorMakerReplicationFlowArgs args, InvokeOptions options)

    fn::invoke:
  function: aiven:index/getMirrorMakerReplicationFlow:getMirrorMakerReplicationFlow
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    SourceCluster string
    Source cluster alias. Maximum length: 128.
    TargetCluster string
    Target cluster alias. Maximum length: 128.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ServiceName string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    SourceCluster string
    Source cluster alias. Maximum length: 128.
    TargetCluster string
    Target cluster alias. Maximum length: 128.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    sourceCluster String
    Source cluster alias. Maximum length: 128.
    targetCluster String
    Target cluster alias. Maximum length: 128.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    sourceCluster string
    Source cluster alias. Maximum length: 128.
    targetCluster string
    Target cluster alias. Maximum length: 128.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    service_name str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    source_cluster str
    Source cluster alias. Maximum length: 128.
    target_cluster str
    Target cluster alias. Maximum length: 128.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    serviceName String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    sourceCluster String
    Source cluster alias. Maximum length: 128.
    targetCluster String
    Target cluster alias. Maximum length: 128.

    getMirrorMakerReplicationFlow Result

    The following output properties are available:

    ConfigPropertiesExcludes List<string>
    List of topic configuration properties and regular expressions to not replicate. The properties that are not replicated by default are: follower.replication.throttled.replicas, leader.replication.throttled.replicas, message.timestamp.difference.max.ms, message.timestamp.type, unclean.leader.election.enable, and min.insync.replicas. Setting this overrides the defaults. For example, to enable replication for 'min.insync.replicas' and 'unclean.leader.election.enable' set this to: ["follower\.replication\.throttled\.replicas", "leader\.replication\.throttled\.replicas", "message\.timestamp\.difference\.max\.ms", "message\.timestamp\.type"]
    EmitBackwardHeartbeatsEnabled bool
    Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
    EmitHeartbeatsEnabled bool
    Enables emitting heartbeats to the target cluster. The default value is false.
    Enable bool
    Enables replication flow for a service.
    ExactlyOnceDeliveryEnabled bool
    Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
    Id string
    The provider-assigned unique ID for this managed resource.
    OffsetSyncsTopicLocation string
    Offset syncs topic location. The possible values are source and target.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ReplicationFactor int
    Replication factor, >= 1.
    ReplicationPolicyClass string
    Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicy and org.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value is org.apache.kafka.connect.mirror.DefaultReplicationPolicy.
    ServiceName string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    SourceCluster string
    Source cluster alias. Maximum length: 128.
    SyncGroupOffsetsEnabled bool
    Sync consumer group offsets. The default value is false.
    SyncGroupOffsetsIntervalSeconds int
    Frequency of consumer group offset sync. The default value is 1.
    TargetCluster string
    Target cluster alias. Maximum length: 128.
    Topics List<string>
    The topics to include in the replica defined by a list of regular expressions in Java format.
    TopicsBlacklists List<string>
    The topics to exclude from the replica defined by a list of regular expressions in Java format.
    ConfigPropertiesExcludes []string
    List of topic configuration properties and regular expressions to not replicate. The properties that are not replicated by default are: follower.replication.throttled.replicas, leader.replication.throttled.replicas, message.timestamp.difference.max.ms, message.timestamp.type, unclean.leader.election.enable, and min.insync.replicas. Setting this overrides the defaults. For example, to enable replication for 'min.insync.replicas' and 'unclean.leader.election.enable' set this to: ["follower\.replication\.throttled\.replicas", "leader\.replication\.throttled\.replicas", "message\.timestamp\.difference\.max\.ms", "message\.timestamp\.type"]
    EmitBackwardHeartbeatsEnabled bool
    Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
    EmitHeartbeatsEnabled bool
    Enables emitting heartbeats to the target cluster. The default value is false.
    Enable bool
    Enables replication flow for a service.
    ExactlyOnceDeliveryEnabled bool
    Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
    Id string
    The provider-assigned unique ID for this managed resource.
    OffsetSyncsTopicLocation string
    Offset syncs topic location. The possible values are source and target.
    Project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    ReplicationFactor int
    Replication factor, >= 1.
    ReplicationPolicyClass string
    Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicy and org.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value is org.apache.kafka.connect.mirror.DefaultReplicationPolicy.
    ServiceName string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    SourceCluster string
    Source cluster alias. Maximum length: 128.
    SyncGroupOffsetsEnabled bool
    Sync consumer group offsets. The default value is false.
    SyncGroupOffsetsIntervalSeconds int
    Frequency of consumer group offset sync. The default value is 1.
    TargetCluster string
    Target cluster alias. Maximum length: 128.
    Topics []string
    The topics to include in the replica defined by a list of regular expressions in Java format.
    TopicsBlacklists []string
    The topics to exclude from the replica defined by a list of regular expressions in Java format.
    configPropertiesExcludes List<String>
    List of topic configuration properties and regular expressions to not replicate. The properties that are not replicated by default are: follower.replication.throttled.replicas, leader.replication.throttled.replicas, message.timestamp.difference.max.ms, message.timestamp.type, unclean.leader.election.enable, and min.insync.replicas. Setting this overrides the defaults. For example, to enable replication for 'min.insync.replicas' and 'unclean.leader.election.enable' set this to: ["follower\.replication\.throttled\.replicas", "leader\.replication\.throttled\.replicas", "message\.timestamp\.difference\.max\.ms", "message\.timestamp\.type"]
    emitBackwardHeartbeatsEnabled Boolean
    Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
    emitHeartbeatsEnabled Boolean
    Enables emitting heartbeats to the target cluster. The default value is false.
    enable Boolean
    Enables replication flow for a service.
    exactlyOnceDeliveryEnabled Boolean
    Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
    id String
    The provider-assigned unique ID for this managed resource.
    offsetSyncsTopicLocation String
    Offset syncs topic location. The possible values are source and target.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    replicationFactor Integer
    Replication factor, >= 1.
    replicationPolicyClass String
    Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicy and org.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value is org.apache.kafka.connect.mirror.DefaultReplicationPolicy.
    serviceName String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    sourceCluster String
    Source cluster alias. Maximum length: 128.
    syncGroupOffsetsEnabled Boolean
    Sync consumer group offsets. The default value is false.
    syncGroupOffsetsIntervalSeconds Integer
    Frequency of consumer group offset sync. The default value is 1.
    targetCluster String
    Target cluster alias. Maximum length: 128.
    topics List<String>
    The topics to include in the replica defined by a list of regular expressions in Java format.
    topicsBlacklists List<String>
    The topics to exclude from the replica defined by a list of regular expressions in Java format.
    configPropertiesExcludes string[]
    List of topic configuration properties and regular expressions to not replicate. The properties that are not replicated by default are: follower.replication.throttled.replicas, leader.replication.throttled.replicas, message.timestamp.difference.max.ms, message.timestamp.type, unclean.leader.election.enable, and min.insync.replicas. Setting this overrides the defaults. For example, to enable replication for 'min.insync.replicas' and 'unclean.leader.election.enable' set this to: ["follower\.replication\.throttled\.replicas", "leader\.replication\.throttled\.replicas", "message\.timestamp\.difference\.max\.ms", "message\.timestamp\.type"]
    emitBackwardHeartbeatsEnabled boolean
    Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
    emitHeartbeatsEnabled boolean
    Enables emitting heartbeats to the target cluster. The default value is false.
    enable boolean
    Enables replication flow for a service.
    exactlyOnceDeliveryEnabled boolean
    Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
    id string
    The provider-assigned unique ID for this managed resource.
    offsetSyncsTopicLocation string
    Offset syncs topic location. The possible values are source and target.
    project string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    replicationFactor number
    Replication factor, >= 1.
    replicationPolicyClass string
    Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicy and org.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value is org.apache.kafka.connect.mirror.DefaultReplicationPolicy.
    serviceName string
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    sourceCluster string
    Source cluster alias. Maximum length: 128.
    syncGroupOffsetsEnabled boolean
    Sync consumer group offsets. The default value is false.
    syncGroupOffsetsIntervalSeconds number
    Frequency of consumer group offset sync. The default value is 1.
    targetCluster string
    Target cluster alias. Maximum length: 128.
    topics string[]
    The topics to include in the replica defined by a list of regular expressions in Java format.
    topicsBlacklists string[]
    The topics to exclude from the replica defined by a list of regular expressions in Java format.
    config_properties_excludes Sequence[str]
    List of topic configuration properties and regular expressions to not replicate. The properties that are not replicated by default are: follower.replication.throttled.replicas, leader.replication.throttled.replicas, message.timestamp.difference.max.ms, message.timestamp.type, unclean.leader.election.enable, and min.insync.replicas. Setting this overrides the defaults. For example, to enable replication for 'min.insync.replicas' and 'unclean.leader.election.enable' set this to: ["follower\.replication\.throttled\.replicas", "leader\.replication\.throttled\.replicas", "message\.timestamp\.difference\.max\.ms", "message\.timestamp\.type"]
    emit_backward_heartbeats_enabled bool
    Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
    emit_heartbeats_enabled bool
    Enables emitting heartbeats to the target cluster. The default value is false.
    enable bool
    Enables replication flow for a service.
    exactly_once_delivery_enabled bool
    Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
    id str
    The provider-assigned unique ID for this managed resource.
    offset_syncs_topic_location str
    Offset syncs topic location. The possible values are source and target.
    project str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    replication_factor int
    Replication factor, >= 1.
    replication_policy_class str
    Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicy and org.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value is org.apache.kafka.connect.mirror.DefaultReplicationPolicy.
    service_name str
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    source_cluster str
    Source cluster alias. Maximum length: 128.
    sync_group_offsets_enabled bool
    Sync consumer group offsets. The default value is false.
    sync_group_offsets_interval_seconds int
    Frequency of consumer group offset sync. The default value is 1.
    target_cluster str
    Target cluster alias. Maximum length: 128.
    topics Sequence[str]
    The topics to include in the replica defined by a list of regular expressions in Java format.
    topics_blacklists Sequence[str]
    The topics to exclude from the replica defined by a list of regular expressions in Java format.
    configPropertiesExcludes List<String>
    List of topic configuration properties and regular expressions to not replicate. The properties that are not replicated by default are: follower.replication.throttled.replicas, leader.replication.throttled.replicas, message.timestamp.difference.max.ms, message.timestamp.type, unclean.leader.election.enable, and min.insync.replicas. Setting this overrides the defaults. For example, to enable replication for 'min.insync.replicas' and 'unclean.leader.election.enable' set this to: ["follower\.replication\.throttled\.replicas", "leader\.replication\.throttled\.replicas", "message\.timestamp\.difference\.max\.ms", "message\.timestamp\.type"]
    emitBackwardHeartbeatsEnabled Boolean
    Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
    emitHeartbeatsEnabled Boolean
    Enables emitting heartbeats to the target cluster. The default value is false.
    enable Boolean
    Enables replication flow for a service.
    exactlyOnceDeliveryEnabled Boolean
    Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
    id String
    The provider-assigned unique ID for this managed resource.
    offsetSyncsTopicLocation String
    Offset syncs topic location. The possible values are source and target.
    project String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    replicationFactor Number
    Replication factor, >= 1.
    replicationPolicyClass String
    Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicy and org.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value is org.apache.kafka.connect.mirror.DefaultReplicationPolicy.
    serviceName String
    The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
    sourceCluster String
    Source cluster alias. Maximum length: 128.
    syncGroupOffsetsEnabled Boolean
    Sync consumer group offsets. The default value is false.
    syncGroupOffsetsIntervalSeconds Number
    Frequency of consumer group offset sync. The default value is 1.
    targetCluster String
    Target cluster alias. Maximum length: 128.
    topics List<String>
    The topics to include in the replica defined by a list of regular expressions in Java format.
    topicsBlacklists List<String>
    The topics to exclude from the replica defined by a list of regular expressions in Java format.

    Package Details

    Repository
    Aiven pulumi/pulumi-aiven
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aiven Terraform Provider.
    aiven logo
    Aiven v6.37.0 published on Thursday, Apr 10, 2025 by Pulumi
    pulumi/pulumi-aiven