aiven.MirrorMakerReplicationFlow
Explore with Pulumi AI
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",
    ],
});
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",
    ])
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
	})
}
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",
        },
    });
});
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());
    }
}
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
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 string
- The unique name of the resource.
- args MirrorMakerReplicationFlowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args MirrorMakerReplicationFlowArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args MirrorMakerReplicationFlowArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
    },
});
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"),
	},
})
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());
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"])
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"],
});
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
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 bool
- Enables replication flow for a service.
- OffsetSyncs stringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- ReplicationPolicy stringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- TargetCluster string
- Target cluster alias. Maximum length: 128.
- ConfigProperties List<string>Excludes 
- 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, andmin.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"]
- EmitBackward boolHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- EmitHeartbeats boolEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- ExactlyOnce boolDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- ReplicationFactor int
- Replication factor, >= 1.
- SyncGroup boolOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- SyncGroup intOffsets Interval Seconds 
- 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 bool
- Enables replication flow for a service.
- OffsetSyncs stringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- ReplicationPolicy stringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- TargetCluster string
- Target cluster alias. Maximum length: 128.
- ConfigProperties []stringExcludes 
- 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, andmin.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"]
- EmitBackward boolHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- EmitHeartbeats boolEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- ExactlyOnce boolDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- ReplicationFactor int
- Replication factor, >= 1.
- SyncGroup boolOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- SyncGroup intOffsets Interval Seconds 
- 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 Boolean
- Enables replication flow for a service.
- offsetSyncs StringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- replicationPolicy StringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- targetCluster String
- Target cluster alias. Maximum length: 128.
- configProperties List<String>Excludes 
- 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, andmin.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"]
- emitBackward BooleanHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emitHeartbeats BooleanEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- exactlyOnce BooleanDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- replicationFactor Integer
- Replication factor, >= 1.
- syncGroup BooleanOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- syncGroup IntegerOffsets Interval Seconds 
- 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 boolean
- Enables replication flow for a service.
- offsetSyncs stringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- replicationPolicy stringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- targetCluster string
- Target cluster alias. Maximum length: 128.
- configProperties string[]Excludes 
- 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, andmin.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"]
- emitBackward booleanHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emitHeartbeats booleanEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- exactlyOnce booleanDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- replicationFactor number
- Replication factor, >= 1.
- syncGroup booleanOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- syncGroup numberOffsets Interval Seconds 
- 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 bool
- Enables replication flow for a service.
- offset_syncs_ strtopic_ location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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_policy_ strclass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- target_cluster str
- Target cluster alias. Maximum length: 128.
- config_properties_ Sequence[str]excludes 
- 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, andmin.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_ boolheartbeats_ enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emit_heartbeats_ boolenabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- exactly_once_ booldelivery_ enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- replication_factor int
- Replication factor, >= 1.
- sync_group_ booloffsets_ enabled 
- Sync consumer group offsets. The default value is false.
- sync_group_ intoffsets_ interval_ seconds 
- 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 Boolean
- Enables replication flow for a service.
- offsetSyncs StringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- replicationPolicy StringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- targetCluster String
- Target cluster alias. Maximum length: 128.
- configProperties List<String>Excludes 
- 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, andmin.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"]
- emitBackward BooleanHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emitHeartbeats BooleanEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- exactlyOnce BooleanDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- replicationFactor Number
- Replication factor, >= 1.
- syncGroup BooleanOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- syncGroup NumberOffsets Interval Seconds 
- 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) -> MirrorMakerReplicationFlowfunc 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- ConfigProperties List<string>Excludes 
- 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, andmin.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"]
- EmitBackward boolHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- EmitHeartbeats boolEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- Enable bool
- Enables replication flow for a service.
- ExactlyOnce boolDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- OffsetSyncs stringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- ReplicationPolicy stringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- SyncGroup boolOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- SyncGroup intOffsets Interval Seconds 
- 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.
- ConfigProperties []stringExcludes 
- 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, andmin.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"]
- EmitBackward boolHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- EmitHeartbeats boolEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- Enable bool
- Enables replication flow for a service.
- ExactlyOnce boolDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- OffsetSyncs stringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- ReplicationPolicy stringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- SyncGroup boolOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- SyncGroup intOffsets Interval Seconds 
- 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.
- configProperties List<String>Excludes 
- 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, andmin.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"]
- emitBackward BooleanHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emitHeartbeats BooleanEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- enable Boolean
- Enables replication flow for a service.
- exactlyOnce BooleanDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- offsetSyncs StringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- replicationPolicy StringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- syncGroup BooleanOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- syncGroup IntegerOffsets Interval Seconds 
- 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.
- configProperties string[]Excludes 
- 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, andmin.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"]
- emitBackward booleanHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emitHeartbeats booleanEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- enable boolean
- Enables replication flow for a service.
- exactlyOnce booleanDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- offsetSyncs stringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- replicationPolicy stringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- syncGroup booleanOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- syncGroup numberOffsets Interval Seconds 
- 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_ Sequence[str]excludes 
- 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, andmin.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_ boolheartbeats_ enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emit_heartbeats_ boolenabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- enable bool
- Enables replication flow for a service.
- exactly_once_ booldelivery_ enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- offset_syncs_ strtopic_ location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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_ strclass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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_ booloffsets_ enabled 
- Sync consumer group offsets. The default value is false.
- sync_group_ intoffsets_ interval_ seconds 
- 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.
- configProperties List<String>Excludes 
- 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, andmin.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"]
- emitBackward BooleanHeartbeats Enabled 
- Enables emitting heartbeats to the direction opposite to the flow, i.e. to the source cluster. The default value is false.
- emitHeartbeats BooleanEnabled 
- Enables emitting heartbeats to the target cluster. The default value is false.
- enable Boolean
- Enables replication flow for a service.
- exactlyOnce BooleanDelivery Enabled 
- Enables exactly-once message delivery. Set this to enabledfor new replications. The default value isfalse.
- offsetSyncs StringTopic Location 
- Offset syncs topic location. The possible values are sourceandtarget.
- 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.
- replicationPolicy StringClass 
- Replication policy class. The possible values are org.apache.kafka.connect.mirror.DefaultReplicationPolicyandorg.apache.kafka.connect.mirror.IdentityReplicationPolicy. The default value isorg.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.
- syncGroup BooleanOffsets Enabled 
- Sync consumer group offsets. The default value is false.
- syncGroup NumberOffsets Interval Seconds 
- 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
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 aivenTerraform Provider.