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

aiven.MirrorMakerReplicationFlow

Explore with Pulumi AI

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

Creates and manages 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 = new aiven.MirrorMakerReplicationFlow("example_replication_flow", {
    project: exampleProject.project,
    serviceName: exampleKafka.serviceName,
    sourceCluster: source.serviceName,
    targetCluster: target.serviceName,
    enable: true,
    topics: [".*"],
    topicsBlacklists: [
        ".*[\\-\\.]internal",
        ".*\\.replica",
        "__.*",
    ],
    configPropertiesExcludes: [
        "follower\\.replication\\.throttled\\.replicas",
        "leader\\.replication\\.throttled\\.replicas",
        "message\\.timestamp\\.difference\\.max\\.ms",
        "message\\.timestamp\\.type",
        "unclean\\.leader\\.election\\.enable",
        "min\\.insync\\.replicas",
    ],
});
Copy
import pulumi
import pulumi_aiven as aiven

example_replication_flow = aiven.MirrorMakerReplicationFlow("example_replication_flow",
    project=example_project["project"],
    service_name=example_kafka["serviceName"],
    source_cluster=source["serviceName"],
    target_cluster=target["serviceName"],
    enable=True,
    topics=[".*"],
    topics_blacklists=[
        ".*[\\-\\.]internal",
        ".*\\.replica",
        "__.*",
    ],
    config_properties_excludes=[
        "follower\\.replication\\.throttled\\.replicas",
        "leader\\.replication\\.throttled\\.replicas",
        "message\\.timestamp\\.difference\\.max\\.ms",
        "message\\.timestamp\\.type",
        "unclean\\.leader\\.election\\.enable",
        "min\\.insync\\.replicas",
    ])
Copy
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.NewMirrorMakerReplicationFlow(ctx, "example_replication_flow", &aiven.MirrorMakerReplicationFlowArgs{
			Project:       pulumi.Any(exampleProject.Project),
			ServiceName:   pulumi.Any(exampleKafka.ServiceName),
			SourceCluster: pulumi.Any(source.ServiceName),
			TargetCluster: pulumi.Any(target.ServiceName),
			Enable:        pulumi.Bool(true),
			Topics: pulumi.StringArray{
				pulumi.String(".*"),
			},
			TopicsBlacklists: pulumi.StringArray{
				pulumi.String(".*[\\-\\.]internal"),
				pulumi.String(".*\\.replica"),
				pulumi.String("__.*"),
			},
			ConfigPropertiesExcludes: pulumi.StringArray{
				pulumi.String("follower\\.replication\\.throttled\\.replicas"),
				pulumi.String("leader\\.replication\\.throttled\\.replicas"),
				pulumi.String("message\\.timestamp\\.difference\\.max\\.ms"),
				pulumi.String("message\\.timestamp\\.type"),
				pulumi.String("unclean\\.leader\\.election\\.enable"),
				pulumi.String("min\\.insync\\.replicas"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var exampleReplicationFlow = new Aiven.MirrorMakerReplicationFlow("example_replication_flow", new()
    {
        Project = exampleProject.Project,
        ServiceName = exampleKafka.ServiceName,
        SourceCluster = source.ServiceName,
        TargetCluster = target.ServiceName,
        Enable = true,
        Topics = new[]
        {
            ".*",
        },
        TopicsBlacklists = new[]
        {
            ".*[\\-\\.]internal",
            ".*\\.replica",
            "__.*",
        },
        ConfigPropertiesExcludes = new[]
        {
            "follower\\.replication\\.throttled\\.replicas",
            "leader\\.replication\\.throttled\\.replicas",
            "message\\.timestamp\\.difference\\.max\\.ms",
            "message\\.timestamp\\.type",
            "unclean\\.leader\\.election\\.enable",
            "min\\.insync\\.replicas",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.MirrorMakerReplicationFlow;
import com.pulumi.aiven.MirrorMakerReplicationFlowArgs;
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) {
        var exampleReplicationFlow = new MirrorMakerReplicationFlow("exampleReplicationFlow", MirrorMakerReplicationFlowArgs.builder()
            .project(exampleProject.project())
            .serviceName(exampleKafka.serviceName())
            .sourceCluster(source.serviceName())
            .targetCluster(target.serviceName())
            .enable(true)
            .topics(".*")
            .topicsBlacklists(            
                ".*[\\-\\.]internal",
                ".*\\.replica",
                "__.*")
            .configPropertiesExcludes(            
                "follower\\.replication\\.throttled\\.replicas",
                "leader\\.replication\\.throttled\\.replicas",
                "message\\.timestamp\\.difference\\.max\\.ms",
                "message\\.timestamp\\.type",
                "unclean\\.leader\\.election\\.enable",
                "min\\.insync\\.replicas")
            .build());

    }
}
Copy
resources:
  exampleReplicationFlow:
    type: aiven:MirrorMakerReplicationFlow
    name: example_replication_flow
    properties:
      project: ${exampleProject.project}
      serviceName: ${exampleKafka.serviceName}
      sourceCluster: ${source.serviceName}
      targetCluster: ${target.serviceName}
      enable: true
      topics:
        - .*
      topicsBlacklists:
        - .*[\-\.]internal
        - .*\.replica
        - __.*
      configPropertiesExcludes:
        - follower\.replication\.throttled\.replicas
        - leader\.replication\.throttled\.replicas
        - message\.timestamp\.difference\.max\.ms
        - message\.timestamp\.type
        - unclean\.leader\.election\.enable
        - min\.insync\.replicas
Copy

Create MirrorMakerReplicationFlow Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new MirrorMakerReplicationFlow(name: string, args: MirrorMakerReplicationFlowArgs, opts?: CustomResourceOptions);
@overload
def MirrorMakerReplicationFlow(resource_name: str,
                               args: MirrorMakerReplicationFlowArgs,
                               opts: Optional[ResourceOptions] = None)

@overload
def MirrorMakerReplicationFlow(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               replication_policy_class: Optional[str] = None,
                               target_cluster: Optional[str] = None,
                               source_cluster: Optional[str] = None,
                               enable: Optional[bool] = None,
                               service_name: Optional[str] = None,
                               offset_syncs_topic_location: Optional[str] = None,
                               project: Optional[str] = None,
                               exactly_once_delivery_enabled: Optional[bool] = None,
                               replication_factor: Optional[int] = None,
                               config_properties_excludes: Optional[Sequence[str]] = None,
                               emit_heartbeats_enabled: Optional[bool] = None,
                               sync_group_offsets_enabled: Optional[bool] = None,
                               sync_group_offsets_interval_seconds: Optional[int] = None,
                               emit_backward_heartbeats_enabled: Optional[bool] = None,
                               topics: Optional[Sequence[str]] = None,
                               topics_blacklists: Optional[Sequence[str]] = None)
func NewMirrorMakerReplicationFlow(ctx *Context, name string, args MirrorMakerReplicationFlowArgs, opts ...ResourceOption) (*MirrorMakerReplicationFlow, error)
public MirrorMakerReplicationFlow(string name, MirrorMakerReplicationFlowArgs args, CustomResourceOptions? opts = null)
public MirrorMakerReplicationFlow(String name, MirrorMakerReplicationFlowArgs args)
public MirrorMakerReplicationFlow(String name, MirrorMakerReplicationFlowArgs args, CustomResourceOptions options)

type: aiven:MirrorMakerReplicationFlow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. MirrorMakerReplicationFlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. MirrorMakerReplicationFlowArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. MirrorMakerReplicationFlowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. MirrorMakerReplicationFlowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. MirrorMakerReplicationFlowArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var mirrorMakerReplicationFlowResource = new Aiven.MirrorMakerReplicationFlow("mirrorMakerReplicationFlowResource", new()
{
    ReplicationPolicyClass = "string",
    TargetCluster = "string",
    SourceCluster = "string",
    Enable = false,
    ServiceName = "string",
    OffsetSyncsTopicLocation = "string",
    Project = "string",
    ExactlyOnceDeliveryEnabled = false,
    ReplicationFactor = 0,
    ConfigPropertiesExcludes = new[]
    {
        "string",
    },
    EmitHeartbeatsEnabled = false,
    SyncGroupOffsetsEnabled = false,
    SyncGroupOffsetsIntervalSeconds = 0,
    EmitBackwardHeartbeatsEnabled = false,
    Topics = new[]
    {
        "string",
    },
    TopicsBlacklists = new[]
    {
        "string",
    },
});
Copy
example, err := aiven.NewMirrorMakerReplicationFlow(ctx, "mirrorMakerReplicationFlowResource", &aiven.MirrorMakerReplicationFlowArgs{
	ReplicationPolicyClass:     pulumi.String("string"),
	TargetCluster:              pulumi.String("string"),
	SourceCluster:              pulumi.String("string"),
	Enable:                     pulumi.Bool(false),
	ServiceName:                pulumi.String("string"),
	OffsetSyncsTopicLocation:   pulumi.String("string"),
	Project:                    pulumi.String("string"),
	ExactlyOnceDeliveryEnabled: pulumi.Bool(false),
	ReplicationFactor:          pulumi.Int(0),
	ConfigPropertiesExcludes: pulumi.StringArray{
		pulumi.String("string"),
	},
	EmitHeartbeatsEnabled:           pulumi.Bool(false),
	SyncGroupOffsetsEnabled:         pulumi.Bool(false),
	SyncGroupOffsetsIntervalSeconds: pulumi.Int(0),
	EmitBackwardHeartbeatsEnabled:   pulumi.Bool(false),
	Topics: pulumi.StringArray{
		pulumi.String("string"),
	},
	TopicsBlacklists: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var mirrorMakerReplicationFlowResource = new MirrorMakerReplicationFlow("mirrorMakerReplicationFlowResource", MirrorMakerReplicationFlowArgs.builder()
    .replicationPolicyClass("string")
    .targetCluster("string")
    .sourceCluster("string")
    .enable(false)
    .serviceName("string")
    .offsetSyncsTopicLocation("string")
    .project("string")
    .exactlyOnceDeliveryEnabled(false)
    .replicationFactor(0)
    .configPropertiesExcludes("string")
    .emitHeartbeatsEnabled(false)
    .syncGroupOffsetsEnabled(false)
    .syncGroupOffsetsIntervalSeconds(0)
    .emitBackwardHeartbeatsEnabled(false)
    .topics("string")
    .topicsBlacklists("string")
    .build());
Copy
mirror_maker_replication_flow_resource = aiven.MirrorMakerReplicationFlow("mirrorMakerReplicationFlowResource",
    replication_policy_class="string",
    target_cluster="string",
    source_cluster="string",
    enable=False,
    service_name="string",
    offset_syncs_topic_location="string",
    project="string",
    exactly_once_delivery_enabled=False,
    replication_factor=0,
    config_properties_excludes=["string"],
    emit_heartbeats_enabled=False,
    sync_group_offsets_enabled=False,
    sync_group_offsets_interval_seconds=0,
    emit_backward_heartbeats_enabled=False,
    topics=["string"],
    topics_blacklists=["string"])
Copy
const mirrorMakerReplicationFlowResource = new aiven.MirrorMakerReplicationFlow("mirrorMakerReplicationFlowResource", {
    replicationPolicyClass: "string",
    targetCluster: "string",
    sourceCluster: "string",
    enable: false,
    serviceName: "string",
    offsetSyncsTopicLocation: "string",
    project: "string",
    exactlyOnceDeliveryEnabled: false,
    replicationFactor: 0,
    configPropertiesExcludes: ["string"],
    emitHeartbeatsEnabled: false,
    syncGroupOffsetsEnabled: false,
    syncGroupOffsetsIntervalSeconds: 0,
    emitBackwardHeartbeatsEnabled: false,
    topics: ["string"],
    topicsBlacklists: ["string"],
});
Copy
type: aiven:MirrorMakerReplicationFlow
properties:
    configPropertiesExcludes:
        - string
    emitBackwardHeartbeatsEnabled: false
    emitHeartbeatsEnabled: false
    enable: false
    exactlyOnceDeliveryEnabled: false
    offsetSyncsTopicLocation: string
    project: string
    replicationFactor: 0
    replicationPolicyClass: string
    serviceName: string
    sourceCluster: string
    syncGroupOffsetsEnabled: false
    syncGroupOffsetsIntervalSeconds: 0
    targetCluster: string
    topics:
        - string
    topicsBlacklists:
        - string
Copy

MirrorMakerReplicationFlow Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The MirrorMakerReplicationFlow resource accepts the following input properties:

Enable This property is required. bool
Enables replication flow for a service.
OffsetSyncsTopicLocation This property is required. string
Offset syncs topic location. The possible values are source and target.
Project
This property is required.
Changes to this property will trigger replacement.
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.
ReplicationPolicyClass This property is required. 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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string
Source cluster alias. Maximum length: 128.
TargetCluster This property is required. string
Target cluster alias. Maximum length: 128.
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.
ExactlyOnceDeliveryEnabled bool
Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
ReplicationFactor int
Replication factor, >= 1.
SyncGroupOffsetsEnabled bool
Sync consumer group offsets. The default value is false.
SyncGroupOffsetsIntervalSeconds int
Frequency of consumer group offset sync. The default value is 1.
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.
Enable This property is required. bool
Enables replication flow for a service.
OffsetSyncsTopicLocation This property is required. string
Offset syncs topic location. The possible values are source and target.
Project
This property is required.
Changes to this property will trigger replacement.
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.
ReplicationPolicyClass This property is required. 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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string
Source cluster alias. Maximum length: 128.
TargetCluster This property is required. string
Target cluster alias. Maximum length: 128.
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.
ExactlyOnceDeliveryEnabled bool
Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
ReplicationFactor int
Replication factor, >= 1.
SyncGroupOffsetsEnabled bool
Sync consumer group offsets. The default value is false.
SyncGroupOffsetsIntervalSeconds int
Frequency of consumer group offset sync. The default value is 1.
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.
enable This property is required. Boolean
Enables replication flow for a service.
offsetSyncsTopicLocation This property is required. String
Offset syncs topic location. The possible values are source and target.
project
This property is required.
Changes to this property will trigger replacement.
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.
replicationPolicyClass This property is required. 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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. String
Source cluster alias. Maximum length: 128.
targetCluster This property is required. String
Target cluster alias. Maximum length: 128.
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.
exactlyOnceDeliveryEnabled Boolean
Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
replicationFactor Integer
Replication factor, >= 1.
syncGroupOffsetsEnabled Boolean
Sync consumer group offsets. The default value is false.
syncGroupOffsetsIntervalSeconds Integer
Frequency of consumer group offset sync. The default value is 1.
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.
enable This property is required. boolean
Enables replication flow for a service.
offsetSyncsTopicLocation This property is required. string
Offset syncs topic location. The possible values are source and target.
project
This property is required.
Changes to this property will trigger replacement.
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.
replicationPolicyClass This property is required. 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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string
Source cluster alias. Maximum length: 128.
targetCluster This property is required. string
Target cluster alias. Maximum length: 128.
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.
exactlyOnceDeliveryEnabled boolean
Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
replicationFactor number
Replication factor, >= 1.
syncGroupOffsetsEnabled boolean
Sync consumer group offsets. The default value is false.
syncGroupOffsetsIntervalSeconds number
Frequency of consumer group offset sync. The default value is 1.
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.
enable This property is required. bool
Enables replication flow for a service.
offset_syncs_topic_location This property is required. str
Offset syncs topic location. The possible values are source and target.
project
This property is required.
Changes to this property will trigger replacement.
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_policy_class This property is required. 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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. str
Source cluster alias. Maximum length: 128.
target_cluster This property is required. str
Target cluster alias. Maximum length: 128.
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.
exactly_once_delivery_enabled bool
Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
replication_factor int
Replication factor, >= 1.
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.
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.
enable This property is required. Boolean
Enables replication flow for a service.
offsetSyncsTopicLocation This property is required. String
Offset syncs topic location. The possible values are source and target.
project
This property is required.
Changes to this property will trigger replacement.
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.
replicationPolicyClass This property is required. 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
This property is required.
Changes to this property will trigger replacement.
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 This property is required. String
Source cluster alias. Maximum length: 128.
targetCluster This property is required. String
Target cluster alias. Maximum length: 128.
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.
exactlyOnceDeliveryEnabled Boolean
Enables exactly-once message delivery. Set this to enabled for new replications. The default value is false.
replicationFactor Number
Replication factor, >= 1.
syncGroupOffsetsEnabled Boolean
Sync consumer group offsets. The default value is false.
syncGroupOffsetsIntervalSeconds Number
Frequency of consumer group offset sync. The default value is 1.
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the MirrorMakerReplicationFlow resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing MirrorMakerReplicationFlow Resource

Get an existing MirrorMakerReplicationFlow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: MirrorMakerReplicationFlowState, opts?: CustomResourceOptions): MirrorMakerReplicationFlow
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_properties_excludes: Optional[Sequence[str]] = None,
        emit_backward_heartbeats_enabled: Optional[bool] = None,
        emit_heartbeats_enabled: Optional[bool] = None,
        enable: Optional[bool] = None,
        exactly_once_delivery_enabled: Optional[bool] = None,
        offset_syncs_topic_location: Optional[str] = None,
        project: Optional[str] = None,
        replication_factor: Optional[int] = None,
        replication_policy_class: Optional[str] = None,
        service_name: Optional[str] = None,
        source_cluster: Optional[str] = None,
        sync_group_offsets_enabled: Optional[bool] = None,
        sync_group_offsets_interval_seconds: Optional[int] = None,
        target_cluster: Optional[str] = None,
        topics: Optional[Sequence[str]] = None,
        topics_blacklists: Optional[Sequence[str]] = None) -> MirrorMakerReplicationFlow
func GetMirrorMakerReplicationFlow(ctx *Context, name string, id IDInput, state *MirrorMakerReplicationFlowState, opts ...ResourceOption) (*MirrorMakerReplicationFlow, error)
public static MirrorMakerReplicationFlow Get(string name, Input<string> id, MirrorMakerReplicationFlowState? state, CustomResourceOptions? opts = null)
public static MirrorMakerReplicationFlow get(String name, Output<String> id, MirrorMakerReplicationFlowState state, CustomResourceOptions options)
resources:  _:    type: aiven:MirrorMakerReplicationFlow    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
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.
OffsetSyncsTopicLocation string
Offset syncs topic location. The possible values are source and target.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
OffsetSyncsTopicLocation string
Offset syncs topic location. The possible values are source and target.
Project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
offsetSyncsTopicLocation String
Offset syncs topic location. The possible values are source and target.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
offsetSyncsTopicLocation string
Offset syncs topic location. The possible values are source and target.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
offset_syncs_topic_location str
Offset syncs topic location. The possible values are source and target.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.
offsetSyncsTopicLocation String
Offset syncs topic location. The possible values are source and target.
project Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Import

$ pulumi import aiven:index/mirrorMakerReplicationFlow:MirrorMakerReplicationFlow example_replication_flow PROJECT/SERVICE_NAME/SOURCE_CLUSTER/TARGET_CLUSTER
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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