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

aiven.KafkaMirrorMaker

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 service.

Example Usage

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

const exampleMirrormaker = new aiven.KafkaMirrorMaker("example_mirrormaker", {
    project: exampleProject.project,
    cloudName: "google-europe-west1",
    plan: "startup-4",
    serviceName: "example-mirrormaker-service",
    kafkaMirrormakerUserConfig: {
        ipFilters: ["0.0.0.0/0"],
        kafkaMirrormaker: {
            refreshGroupsIntervalSeconds: 600,
            refreshTopicsEnabled: true,
            refreshTopicsIntervalSeconds: 600,
        },
    },
});
Copy
import pulumi
import pulumi_aiven as aiven

example_mirrormaker = aiven.KafkaMirrorMaker("example_mirrormaker",
    project=example_project["project"],
    cloud_name="google-europe-west1",
    plan="startup-4",
    service_name="example-mirrormaker-service",
    kafka_mirrormaker_user_config={
        "ip_filters": ["0.0.0.0/0"],
        "kafka_mirrormaker": {
            "refresh_groups_interval_seconds": 600,
            "refresh_topics_enabled": True,
            "refresh_topics_interval_seconds": 600,
        },
    })
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.NewKafkaMirrorMaker(ctx, "example_mirrormaker", &aiven.KafkaMirrorMakerArgs{
			Project:     pulumi.Any(exampleProject.Project),
			CloudName:   pulumi.String("google-europe-west1"),
			Plan:        pulumi.String("startup-4"),
			ServiceName: pulumi.String("example-mirrormaker-service"),
			KafkaMirrormakerUserConfig: &aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs{
				IpFilters: pulumi.StringArray{
					pulumi.String("0.0.0.0/0"),
				},
				KafkaMirrormaker: &aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs{
					RefreshGroupsIntervalSeconds: pulumi.Int(600),
					RefreshTopicsEnabled:         pulumi.Bool(true),
					RefreshTopicsIntervalSeconds: pulumi.Int(600),
				},
			},
		})
		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 exampleMirrormaker = new Aiven.KafkaMirrorMaker("example_mirrormaker", new()
    {
        Project = exampleProject.Project,
        CloudName = "google-europe-west1",
        Plan = "startup-4",
        ServiceName = "example-mirrormaker-service",
        KafkaMirrormakerUserConfig = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
        {
            IpFilters = new[]
            {
                "0.0.0.0/0",
            },
            KafkaMirrormaker = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs
            {
                RefreshGroupsIntervalSeconds = 600,
                RefreshTopicsEnabled = true,
                RefreshTopicsIntervalSeconds = 600,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.KafkaMirrorMaker;
import com.pulumi.aiven.KafkaMirrorMakerArgs;
import com.pulumi.aiven.inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs;
import com.pulumi.aiven.inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs;
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 exampleMirrormaker = new KafkaMirrorMaker("exampleMirrormaker", KafkaMirrorMakerArgs.builder()
            .project(exampleProject.project())
            .cloudName("google-europe-west1")
            .plan("startup-4")
            .serviceName("example-mirrormaker-service")
            .kafkaMirrormakerUserConfig(KafkaMirrorMakerKafkaMirrormakerUserConfigArgs.builder()
                .ipFilters("0.0.0.0/0")
                .kafkaMirrormaker(KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs.builder()
                    .refreshGroupsIntervalSeconds(600)
                    .refreshTopicsEnabled(true)
                    .refreshTopicsIntervalSeconds(600)
                    .build())
                .build())
            .build());

    }
}
Copy
resources:
  exampleMirrormaker:
    type: aiven:KafkaMirrorMaker
    name: example_mirrormaker
    properties:
      project: ${exampleProject.project}
      cloudName: google-europe-west1
      plan: startup-4
      serviceName: example-mirrormaker-service
      kafkaMirrormakerUserConfig:
        ipFilters:
          - 0.0.0.0/0
        kafkaMirrormaker:
          refreshGroupsIntervalSeconds: 600
          refreshTopicsEnabled: true
          refreshTopicsIntervalSeconds: 600
Copy

Create KafkaMirrorMaker Resource

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

Constructor syntax

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

@overload
def KafkaMirrorMaker(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     plan: Optional[str] = None,
                     service_name: Optional[str] = None,
                     project: Optional[str] = None,
                     kafka_mirrormaker_user_config: Optional[KafkaMirrorMakerKafkaMirrormakerUserConfigArgs] = None,
                     maintenance_window_dow: Optional[str] = None,
                     maintenance_window_time: Optional[str] = None,
                     additional_disk_space: Optional[str] = None,
                     disk_space: Optional[str] = None,
                     project_vpc_id: Optional[str] = None,
                     service_integrations: Optional[Sequence[KafkaMirrorMakerServiceIntegrationArgs]] = None,
                     cloud_name: Optional[str] = None,
                     static_ips: Optional[Sequence[str]] = None,
                     tags: Optional[Sequence[KafkaMirrorMakerTagArgs]] = None,
                     tech_emails: Optional[Sequence[KafkaMirrorMakerTechEmailArgs]] = None,
                     termination_protection: Optional[bool] = None)
func NewKafkaMirrorMaker(ctx *Context, name string, args KafkaMirrorMakerArgs, opts ...ResourceOption) (*KafkaMirrorMaker, error)
public KafkaMirrorMaker(string name, KafkaMirrorMakerArgs args, CustomResourceOptions? opts = null)
public KafkaMirrorMaker(String name, KafkaMirrorMakerArgs args)
public KafkaMirrorMaker(String name, KafkaMirrorMakerArgs args, CustomResourceOptions options)

type: aiven:KafkaMirrorMaker
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. KafkaMirrorMakerArgs
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. KafkaMirrorMakerArgs
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. KafkaMirrorMakerArgs
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. KafkaMirrorMakerArgs
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. KafkaMirrorMakerArgs
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 kafkaMirrorMakerResource = new Aiven.KafkaMirrorMaker("kafkaMirrorMakerResource", new()
{
    Plan = "string",
    ServiceName = "string",
    Project = "string",
    KafkaMirrormakerUserConfig = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
    {
        IpFilterObjects = new[]
        {
            new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObjectArgs
            {
                Network = "string",
                Description = "string",
            },
        },
        IpFilterStrings = new[]
        {
            "string",
        },
        KafkaMirrormaker = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs
        {
            AdminTimeoutMs = 0,
            EmitCheckpointsEnabled = false,
            EmitCheckpointsIntervalSeconds = 0,
            Groups = "string",
            GroupsExclude = "string",
            OffsetLagMax = 0,
            RefreshGroupsEnabled = false,
            RefreshGroupsIntervalSeconds = 0,
            RefreshTopicsEnabled = false,
            RefreshTopicsIntervalSeconds = 0,
            SyncGroupOffsetsEnabled = false,
            SyncGroupOffsetsIntervalSeconds = 0,
            SyncTopicConfigsEnabled = false,
            TasksMaxPerCpu = 0,
        },
        ServiceLog = false,
        StaticIps = false,
    },
    MaintenanceWindowDow = "string",
    MaintenanceWindowTime = "string",
    AdditionalDiskSpace = "string",
    ProjectVpcId = "string",
    ServiceIntegrations = new[]
    {
        new Aiven.Inputs.KafkaMirrorMakerServiceIntegrationArgs
        {
            IntegrationType = "string",
            SourceServiceName = "string",
        },
    },
    CloudName = "string",
    StaticIps = new[]
    {
        "string",
    },
    Tags = new[]
    {
        new Aiven.Inputs.KafkaMirrorMakerTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    TechEmails = new[]
    {
        new Aiven.Inputs.KafkaMirrorMakerTechEmailArgs
        {
            Email = "string",
        },
    },
    TerminationProtection = false,
});
Copy
example, err := aiven.NewKafkaMirrorMaker(ctx, "kafkaMirrorMakerResource", &aiven.KafkaMirrorMakerArgs{
	Plan:        pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	Project:     pulumi.String("string"),
	KafkaMirrormakerUserConfig: &aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs{
		IpFilterObjects: aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObjectArray{
			&aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObjectArgs{
				Network:     pulumi.String("string"),
				Description: pulumi.String("string"),
			},
		},
		IpFilterStrings: pulumi.StringArray{
			pulumi.String("string"),
		},
		KafkaMirrormaker: &aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs{
			AdminTimeoutMs:                  pulumi.Int(0),
			EmitCheckpointsEnabled:          pulumi.Bool(false),
			EmitCheckpointsIntervalSeconds:  pulumi.Int(0),
			Groups:                          pulumi.String("string"),
			GroupsExclude:                   pulumi.String("string"),
			OffsetLagMax:                    pulumi.Int(0),
			RefreshGroupsEnabled:            pulumi.Bool(false),
			RefreshGroupsIntervalSeconds:    pulumi.Int(0),
			RefreshTopicsEnabled:            pulumi.Bool(false),
			RefreshTopicsIntervalSeconds:    pulumi.Int(0),
			SyncGroupOffsetsEnabled:         pulumi.Bool(false),
			SyncGroupOffsetsIntervalSeconds: pulumi.Int(0),
			SyncTopicConfigsEnabled:         pulumi.Bool(false),
			TasksMaxPerCpu:                  pulumi.Int(0),
		},
		ServiceLog: pulumi.Bool(false),
		StaticIps:  pulumi.Bool(false),
	},
	MaintenanceWindowDow:  pulumi.String("string"),
	MaintenanceWindowTime: pulumi.String("string"),
	AdditionalDiskSpace:   pulumi.String("string"),
	ProjectVpcId:          pulumi.String("string"),
	ServiceIntegrations: aiven.KafkaMirrorMakerServiceIntegrationArray{
		&aiven.KafkaMirrorMakerServiceIntegrationArgs{
			IntegrationType:   pulumi.String("string"),
			SourceServiceName: pulumi.String("string"),
		},
	},
	CloudName: pulumi.String("string"),
	StaticIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: aiven.KafkaMirrorMakerTagArray{
		&aiven.KafkaMirrorMakerTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	TechEmails: aiven.KafkaMirrorMakerTechEmailArray{
		&aiven.KafkaMirrorMakerTechEmailArgs{
			Email: pulumi.String("string"),
		},
	},
	TerminationProtection: pulumi.Bool(false),
})
Copy
var kafkaMirrorMakerResource = new KafkaMirrorMaker("kafkaMirrorMakerResource", KafkaMirrorMakerArgs.builder()
    .plan("string")
    .serviceName("string")
    .project("string")
    .kafkaMirrormakerUserConfig(KafkaMirrorMakerKafkaMirrormakerUserConfigArgs.builder()
        .ipFilterObjects(KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObjectArgs.builder()
            .network("string")
            .description("string")
            .build())
        .ipFilterStrings("string")
        .kafkaMirrormaker(KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs.builder()
            .adminTimeoutMs(0)
            .emitCheckpointsEnabled(false)
            .emitCheckpointsIntervalSeconds(0)
            .groups("string")
            .groupsExclude("string")
            .offsetLagMax(0)
            .refreshGroupsEnabled(false)
            .refreshGroupsIntervalSeconds(0)
            .refreshTopicsEnabled(false)
            .refreshTopicsIntervalSeconds(0)
            .syncGroupOffsetsEnabled(false)
            .syncGroupOffsetsIntervalSeconds(0)
            .syncTopicConfigsEnabled(false)
            .tasksMaxPerCpu(0)
            .build())
        .serviceLog(false)
        .staticIps(false)
        .build())
    .maintenanceWindowDow("string")
    .maintenanceWindowTime("string")
    .additionalDiskSpace("string")
    .projectVpcId("string")
    .serviceIntegrations(KafkaMirrorMakerServiceIntegrationArgs.builder()
        .integrationType("string")
        .sourceServiceName("string")
        .build())
    .cloudName("string")
    .staticIps("string")
    .tags(KafkaMirrorMakerTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .techEmails(KafkaMirrorMakerTechEmailArgs.builder()
        .email("string")
        .build())
    .terminationProtection(false)
    .build());
Copy
kafka_mirror_maker_resource = aiven.KafkaMirrorMaker("kafkaMirrorMakerResource",
    plan="string",
    service_name="string",
    project="string",
    kafka_mirrormaker_user_config={
        "ip_filter_objects": [{
            "network": "string",
            "description": "string",
        }],
        "ip_filter_strings": ["string"],
        "kafka_mirrormaker": {
            "admin_timeout_ms": 0,
            "emit_checkpoints_enabled": False,
            "emit_checkpoints_interval_seconds": 0,
            "groups": "string",
            "groups_exclude": "string",
            "offset_lag_max": 0,
            "refresh_groups_enabled": False,
            "refresh_groups_interval_seconds": 0,
            "refresh_topics_enabled": False,
            "refresh_topics_interval_seconds": 0,
            "sync_group_offsets_enabled": False,
            "sync_group_offsets_interval_seconds": 0,
            "sync_topic_configs_enabled": False,
            "tasks_max_per_cpu": 0,
        },
        "service_log": False,
        "static_ips": False,
    },
    maintenance_window_dow="string",
    maintenance_window_time="string",
    additional_disk_space="string",
    project_vpc_id="string",
    service_integrations=[{
        "integration_type": "string",
        "source_service_name": "string",
    }],
    cloud_name="string",
    static_ips=["string"],
    tags=[{
        "key": "string",
        "value": "string",
    }],
    tech_emails=[{
        "email": "string",
    }],
    termination_protection=False)
Copy
const kafkaMirrorMakerResource = new aiven.KafkaMirrorMaker("kafkaMirrorMakerResource", {
    plan: "string",
    serviceName: "string",
    project: "string",
    kafkaMirrormakerUserConfig: {
        ipFilterObjects: [{
            network: "string",
            description: "string",
        }],
        ipFilterStrings: ["string"],
        kafkaMirrormaker: {
            adminTimeoutMs: 0,
            emitCheckpointsEnabled: false,
            emitCheckpointsIntervalSeconds: 0,
            groups: "string",
            groupsExclude: "string",
            offsetLagMax: 0,
            refreshGroupsEnabled: false,
            refreshGroupsIntervalSeconds: 0,
            refreshTopicsEnabled: false,
            refreshTopicsIntervalSeconds: 0,
            syncGroupOffsetsEnabled: false,
            syncGroupOffsetsIntervalSeconds: 0,
            syncTopicConfigsEnabled: false,
            tasksMaxPerCpu: 0,
        },
        serviceLog: false,
        staticIps: false,
    },
    maintenanceWindowDow: "string",
    maintenanceWindowTime: "string",
    additionalDiskSpace: "string",
    projectVpcId: "string",
    serviceIntegrations: [{
        integrationType: "string",
        sourceServiceName: "string",
    }],
    cloudName: "string",
    staticIps: ["string"],
    tags: [{
        key: "string",
        value: "string",
    }],
    techEmails: [{
        email: "string",
    }],
    terminationProtection: false,
});
Copy
type: aiven:KafkaMirrorMaker
properties:
    additionalDiskSpace: string
    cloudName: string
    kafkaMirrormakerUserConfig:
        ipFilterObjects:
            - description: string
              network: string
        ipFilterStrings:
            - string
        kafkaMirrormaker:
            adminTimeoutMs: 0
            emitCheckpointsEnabled: false
            emitCheckpointsIntervalSeconds: 0
            groups: string
            groupsExclude: string
            offsetLagMax: 0
            refreshGroupsEnabled: false
            refreshGroupsIntervalSeconds: 0
            refreshTopicsEnabled: false
            refreshTopicsIntervalSeconds: 0
            syncGroupOffsetsEnabled: false
            syncGroupOffsetsIntervalSeconds: 0
            syncTopicConfigsEnabled: false
            tasksMaxPerCpu: 0
        serviceLog: false
        staticIps: false
    maintenanceWindowDow: string
    maintenanceWindowTime: string
    plan: string
    project: string
    projectVpcId: string
    serviceIntegrations:
        - integrationType: string
          sourceServiceName: string
    serviceName: string
    staticIps:
        - string
    tags:
        - key: string
          value: string
    techEmails:
        - email: string
    terminationProtection: false
Copy

KafkaMirrorMaker 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 KafkaMirrorMaker resource accepts the following input properties:

Plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations List<KafkaMirrorMakerServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<KafkaMirrorMakerTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<KafkaMirrorMakerTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
Plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceIntegrations []KafkaMirrorMakerServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []KafkaMirrorMakerTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []KafkaMirrorMakerTechEmailArgs
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations List<KafkaMirrorMakerServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<KafkaMirrorMakerTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<KafkaMirrorMakerTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations KafkaMirrorMakerServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags KafkaMirrorMakerTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails KafkaMirrorMakerTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
service_name
This property is required.
Changes to this property will trigger replacement.
str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafka_mirrormaker_user_config KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_integrations Sequence[KafkaMirrorMakerServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[KafkaMirrorMakerTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[KafkaMirrorMakerTechEmailArgs]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
plan This property is required. String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaMirrormakerUserConfig Property Map
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Outputs

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

Components List<KafkaMirrorMakerComponent>
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
Components []KafkaMirrorMakerComponent
Service component information objects
DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string
The hostname of the service.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
components List<KafkaMirrorMakerComponent>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
components KafkaMirrorMakerComponent[]
Service component information objects
diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id string
The provider-assigned unique ID for this managed resource.
serviceHost string
The hostname of the service.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
components Sequence[KafkaMirrorMakerComponent]
Service component information objects
disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id str
The provider-assigned unique ID for this managed resource.
service_host str
The hostname of the service.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
components List<Property Map>
Service component information objects
diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

id String
The provider-assigned unique ID for this managed resource.
serviceHost String
The hostname of the service.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String

Look up Existing KafkaMirrorMaker Resource

Get an existing KafkaMirrorMaker 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?: KafkaMirrorMakerState, opts?: CustomResourceOptions): KafkaMirrorMaker
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_disk_space: Optional[str] = None,
        cloud_name: Optional[str] = None,
        components: Optional[Sequence[KafkaMirrorMakerComponentArgs]] = None,
        disk_space: Optional[str] = None,
        disk_space_cap: Optional[str] = None,
        disk_space_default: Optional[str] = None,
        disk_space_step: Optional[str] = None,
        disk_space_used: Optional[str] = None,
        kafka_mirrormaker_user_config: Optional[KafkaMirrorMakerKafkaMirrormakerUserConfigArgs] = None,
        maintenance_window_dow: Optional[str] = None,
        maintenance_window_time: Optional[str] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        project_vpc_id: Optional[str] = None,
        service_host: Optional[str] = None,
        service_integrations: Optional[Sequence[KafkaMirrorMakerServiceIntegrationArgs]] = None,
        service_name: Optional[str] = None,
        service_password: Optional[str] = None,
        service_port: Optional[int] = None,
        service_type: Optional[str] = None,
        service_uri: Optional[str] = None,
        service_username: Optional[str] = None,
        state: Optional[str] = None,
        static_ips: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[KafkaMirrorMakerTagArgs]] = None,
        tech_emails: Optional[Sequence[KafkaMirrorMakerTechEmailArgs]] = None,
        termination_protection: Optional[bool] = None) -> KafkaMirrorMaker
func GetKafkaMirrorMaker(ctx *Context, name string, id IDInput, state *KafkaMirrorMakerState, opts ...ResourceOption) (*KafkaMirrorMaker, error)
public static KafkaMirrorMaker Get(string name, Input<string> id, KafkaMirrorMakerState? state, CustomResourceOptions? opts = null)
public static KafkaMirrorMaker get(String name, Output<String> id, KafkaMirrorMakerState state, CustomResourceOptions options)
resources:  _:    type: aiven:KafkaMirrorMaker    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:
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components List<KafkaMirrorMakerComponent>
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations List<KafkaMirrorMakerServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps List<string>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags List<KafkaMirrorMakerTag>
Tags are key-value pairs that allow you to categorize services.
TechEmails List<KafkaMirrorMakerTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
AdditionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
CloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
Components []KafkaMirrorMakerComponentArgs
Service component information objects
DiskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

DiskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
DiskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
DiskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
DiskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
MaintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
MaintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
Plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
ProjectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
ServiceHost string
The hostname of the service.
ServiceIntegrations []KafkaMirrorMakerServiceIntegrationArgs
Service integrations to specify when creating a service. Not applied after initial service creation
ServiceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
ServicePassword string
Password used for connecting to the service, if applicable
ServicePort int
The port of the service
ServiceType string
Aiven internal service type code
ServiceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
ServiceUsername string
Username used for connecting to the service, if applicable
State string
StaticIps []string
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
Tags []KafkaMirrorMakerTagArgs
Tags are key-value pairs that allow you to categorize services.
TechEmails []KafkaMirrorMakerTechEmailArgs
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
TerminationProtection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<KafkaMirrorMakerComponent>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<KafkaMirrorMakerServiceIntegration>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Integer
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<KafkaMirrorMakerTag>
Tags are key-value pairs that allow you to categorize services.
techEmails List<KafkaMirrorMakerTechEmail>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace string
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName string
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components KafkaMirrorMakerComponent[]
Service component information objects
diskSpace string
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap string
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault string
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep string
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed string
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow string
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime string
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan string
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
projectVpcId string
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost string
The hostname of the service.
serviceIntegrations KafkaMirrorMakerServiceIntegration[]
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. string
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword string
Password used for connecting to the service, if applicable
servicePort number
The port of the service
serviceType string
Aiven internal service type code
serviceUri string
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername string
Username used for connecting to the service, if applicable
state string
staticIps string[]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags KafkaMirrorMakerTag[]
Tags are key-value pairs that allow you to categorize services.
techEmails KafkaMirrorMakerTechEmail[]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additional_disk_space str
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloud_name str
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components Sequence[KafkaMirrorMakerComponentArgs]
Service component information objects
disk_space str
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

disk_space_cap str
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafka_mirrormaker_user_config KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenance_window_dow str
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenance_window_time str
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan str
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
project_vpc_id str
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
service_host str
The hostname of the service.
service_integrations Sequence[KafkaMirrorMakerServiceIntegrationArgs]
Service integrations to specify when creating a service. Not applied after initial service creation
service_name Changes to this property will trigger replacement. str
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
service_password str
Password used for connecting to the service, if applicable
service_port int
The port of the service
service_type str
Aiven internal service type code
service_uri str
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
service_username str
Username used for connecting to the service, if applicable
state str
static_ips Sequence[str]
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags Sequence[KafkaMirrorMakerTagArgs]
Tags are key-value pairs that allow you to categorize services.
tech_emails Sequence[KafkaMirrorMakerTechEmailArgs]
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
termination_protection bool
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.
additionalDiskSpace String
Add disk storage in increments of 30 GiB to scale your service. The maximum value depends on the service type and cloud provider. Removing additional storage causes the service nodes to go through a rolling restart, and there might be a short downtime for services without an autoscaler integration or high availability capabilities. The field can be safely removed when autoscaler is enabled without causing any changes.
cloudName String
The cloud provider and region the service is hosted in. The format is provider-region, for example: google-europe-west1. The available cloud regions can differ per project and service. Changing this value migrates the service to another cloud provider or region. The migration runs in the background and includes a DNS update to redirect traffic to the new region. Most services experience no downtime, but some databases may have a brief interruption during DNS propagation.
components List<Property Map>
Service component information objects
diskSpace String
Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

diskSpaceCap String
The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String
The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String
The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String
Disk space that service is currently using

Deprecated: This will be removed in v5.0.0. Please use additional_disk_space to specify the space to be added to the default disk_space defined by the plan.

kafkaMirrormakerUserConfig Property Map
KafkaMirrormaker user configurable settings. Warning: There's no way to reset advanced configuration options to default. Options that you add cannot be removed later
maintenanceWindowDow String
Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
maintenanceWindowTime String
Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
plan String
Defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seen from the Aiven pricing page.
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.
projectVpcId String
Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.
serviceHost String
The hostname of the service.
serviceIntegrations List<Property Map>
Service integrations to specify when creating a service. Not applied after initial service creation
serviceName Changes to this property will trigger replacement. String
Specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.
servicePassword String
Password used for connecting to the service, if applicable
servicePort Number
The port of the service
serviceType String
Aiven internal service type code
serviceUri String
URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String
Username used for connecting to the service, if applicable
state String
staticIps List<String>
Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again
tags List<Property Map>
Tags are key-value pairs that allow you to categorize services.
techEmails List<Property Map>
The email addresses for service contacts, who will receive important alerts and updates about this service. You can also set email contacts at the project level.
terminationProtection Boolean
Prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Supporting Types

KafkaMirrorMakerComponent
, KafkaMirrorMakerComponentArgs

Component string
Service component name
ConnectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
Host string
Host name for connecting to the service component
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int
Port number for connecting to the service component
Route string
Network access route
Ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string
DNS usage name
Component string
Service component name
ConnectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
Host string
Host name for connecting to the service component
KafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
KafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
Port int
Port number for connecting to the service component
Route string
Network access route
Ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
Usage string
DNS usage name
component String
Service component name
connectionUri String
Connection info for connecting to the service component. This is a combination of host and port.
host String
Host name for connecting to the service component
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port Integer
Port number for connecting to the service component
route String
Network access route
ssl Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String
DNS usage name
component string
Service component name
connectionUri string
Connection info for connecting to the service component. This is a combination of host and port.
host string
Host name for connecting to the service component
kafkaAuthenticationMethod string
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa string
Kafka certificate used. The possible values are letsencrypt and project_ca.
port number
Port number for connecting to the service component
route string
Network access route
ssl boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage string
DNS usage name
component str
Service component name
connection_uri str
Connection info for connecting to the service component. This is a combination of host and port.
host str
Host name for connecting to the service component
kafka_authentication_method str
Kafka authentication method. This is a value specific to the 'kafka' service component
kafka_ssl_ca str
Kafka certificate used. The possible values are letsencrypt and project_ca.
port int
Port number for connecting to the service component
route str
Network access route
ssl bool
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage str
DNS usage name
component String
Service component name
connectionUri String
Connection info for connecting to the service component. This is a combination of host and port.
host String
Host name for connecting to the service component
kafkaAuthenticationMethod String
Kafka authentication method. This is a value specific to the 'kafka' service component
kafkaSslCa String
Kafka certificate used. The possible values are letsencrypt and project_ca.
port Number
Port number for connecting to the service component
route String
Network access route
ssl Boolean
Whether the endpoint is encrypted or accepts plaintext. By default endpoints are always encrypted and this property is only included for service components they may disable encryption
usage String
DNS usage name

KafkaMirrorMakerKafkaMirrormakerUserConfig
, KafkaMirrorMakerKafkaMirrormakerUserConfigArgs

AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

IpFilterObjects List<KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters List<string>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
Kafka MirrorMaker configuration values
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
StaticIps bool
Use static public IP addresses.
AdditionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

IpFilterObjects []KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
IpFilterStrings []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
IpFilters []string
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
Kafka MirrorMaker configuration values
ServiceLog bool
Store logs for the service so that they are available in the HTTP API and console.
StaticIps bool
Use static public IP addresses.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ipFilterObjects List<KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
Kafka MirrorMaker configuration values
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps Boolean
Use static public IP addresses.
additionalBackupRegions string
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ipFilterObjects KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters string[]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
Kafka MirrorMaker configuration values
serviceLog boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps boolean
Use static public IP addresses.
additional_backup_regions str
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ip_filter_objects Sequence[KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ip_filter_strings Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ip_filters Sequence[str]
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafka_mirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
Kafka MirrorMaker configuration values
service_log bool
Store logs for the service so that they are available in the HTTP API and console.
static_ips bool
Use static public IP addresses.
additionalBackupRegions String
Additional Cloud Regions for Backup Replication.

Deprecated: This property is deprecated.

ipFilterObjects List<Property Map>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16
ipFilterStrings List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.
ipFilters List<String>
Allow incoming connections from CIDR address block, e.g. 10.20.0.0/16.

Deprecated: Deprecated. Use ip_filter_string instead.

kafkaMirrormaker Property Map
Kafka MirrorMaker configuration values
serviceLog Boolean
Store logs for the service so that they are available in the HTTP API and console.
staticIps Boolean
Use static public IP addresses.

KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject
, KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObjectArgs

Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
Network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
Description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.
network This property is required. string
CIDR address block. Example: 10.20.0.0/16.
description string
Description for IP filter list entry. Example: Production service IP range.
network This property is required. str
CIDR address block. Example: 10.20.0.0/16.
description str
Description for IP filter list entry. Example: Production service IP range.
network This property is required. String
CIDR address block. Example: 10.20.0.0/16.
description String
Description for IP filter list entry. Example: Production service IP range.

KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
, KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs

AdminTimeoutMs int
Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
EmitCheckpointsEnabled bool
Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
EmitCheckpointsIntervalSeconds int
Frequency at which consumer group offset checkpoints are emitted (default: 60, every minute). Example: 60.
Groups string
Consumer groups to replicate. Supports comma-separated group IDs and regexes. Example: .*.
GroupsExclude string
Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example: console-consumer-.*,connect-.*,__.*.
OffsetLagMax int
How out-of-sync a remote partition can be before it is resynced. Example: 100.
RefreshGroupsEnabled bool
Whether to periodically check for new consumer groups. Defaults to true.
RefreshGroupsIntervalSeconds int
Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
RefreshTopicsEnabled bool
Whether to periodically check for new topics and partitions. Defaults to true.
RefreshTopicsIntervalSeconds int
Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
SyncGroupOffsetsEnabled bool
Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to _consumeroffsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster.
SyncGroupOffsetsIntervalSeconds int
Frequency at which consumer group offsets are synced (default: 60, every minute). Example: 60.
SyncTopicConfigsEnabled bool
Whether to periodically configure remote topics to match their corresponding upstream topics.
TasksMaxPerCpu int
tasks.max is set to this multiplied by the number of CPUs in the service. Default: 1.
AdminTimeoutMs int
Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
EmitCheckpointsEnabled bool
Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
EmitCheckpointsIntervalSeconds int
Frequency at which consumer group offset checkpoints are emitted (default: 60, every minute). Example: 60.
Groups string
Consumer groups to replicate. Supports comma-separated group IDs and regexes. Example: .*.
GroupsExclude string
Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example: console-consumer-.*,connect-.*,__.*.
OffsetLagMax int
How out-of-sync a remote partition can be before it is resynced. Example: 100.
RefreshGroupsEnabled bool
Whether to periodically check for new consumer groups. Defaults to true.
RefreshGroupsIntervalSeconds int
Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
RefreshTopicsEnabled bool
Whether to periodically check for new topics and partitions. Defaults to true.
RefreshTopicsIntervalSeconds int
Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
SyncGroupOffsetsEnabled bool
Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to _consumeroffsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster.
SyncGroupOffsetsIntervalSeconds int
Frequency at which consumer group offsets are synced (default: 60, every minute). Example: 60.
SyncTopicConfigsEnabled bool
Whether to periodically configure remote topics to match their corresponding upstream topics.
TasksMaxPerCpu int
tasks.max is set to this multiplied by the number of CPUs in the service. Default: 1.
adminTimeoutMs Integer
Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
emitCheckpointsEnabled Boolean
Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
emitCheckpointsIntervalSeconds Integer
Frequency at which consumer group offset checkpoints are emitted (default: 60, every minute). Example: 60.
groups String
Consumer groups to replicate. Supports comma-separated group IDs and regexes. Example: .*.
groupsExclude String
Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example: console-consumer-.*,connect-.*,__.*.
offsetLagMax Integer
How out-of-sync a remote partition can be before it is resynced. Example: 100.
refreshGroupsEnabled Boolean
Whether to periodically check for new consumer groups. Defaults to true.
refreshGroupsIntervalSeconds Integer
Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
refreshTopicsEnabled Boolean
Whether to periodically check for new topics and partitions. Defaults to true.
refreshTopicsIntervalSeconds Integer
Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
syncGroupOffsetsEnabled Boolean
Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to _consumeroffsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster.
syncGroupOffsetsIntervalSeconds Integer
Frequency at which consumer group offsets are synced (default: 60, every minute). Example: 60.
syncTopicConfigsEnabled Boolean
Whether to periodically configure remote topics to match their corresponding upstream topics.
tasksMaxPerCpu Integer
tasks.max is set to this multiplied by the number of CPUs in the service. Default: 1.
adminTimeoutMs number
Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
emitCheckpointsEnabled boolean
Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
emitCheckpointsIntervalSeconds number
Frequency at which consumer group offset checkpoints are emitted (default: 60, every minute). Example: 60.
groups string
Consumer groups to replicate. Supports comma-separated group IDs and regexes. Example: .*.
groupsExclude string
Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example: console-consumer-.*,connect-.*,__.*.
offsetLagMax number
How out-of-sync a remote partition can be before it is resynced. Example: 100.
refreshGroupsEnabled boolean
Whether to periodically check for new consumer groups. Defaults to true.
refreshGroupsIntervalSeconds number
Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
refreshTopicsEnabled boolean
Whether to periodically check for new topics and partitions. Defaults to true.
refreshTopicsIntervalSeconds number
Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
syncGroupOffsetsEnabled boolean
Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to _consumeroffsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster.
syncGroupOffsetsIntervalSeconds number
Frequency at which consumer group offsets are synced (default: 60, every minute). Example: 60.
syncTopicConfigsEnabled boolean
Whether to periodically configure remote topics to match their corresponding upstream topics.
tasksMaxPerCpu number
tasks.max is set to this multiplied by the number of CPUs in the service. Default: 1.
admin_timeout_ms int
Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
emit_checkpoints_enabled bool
Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
emit_checkpoints_interval_seconds int
Frequency at which consumer group offset checkpoints are emitted (default: 60, every minute). Example: 60.
groups str
Consumer groups to replicate. Supports comma-separated group IDs and regexes. Example: .*.
groups_exclude str
Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example: console-consumer-.*,connect-.*,__.*.
offset_lag_max int
How out-of-sync a remote partition can be before it is resynced. Example: 100.
refresh_groups_enabled bool
Whether to periodically check for new consumer groups. Defaults to true.
refresh_groups_interval_seconds int
Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
refresh_topics_enabled bool
Whether to periodically check for new topics and partitions. Defaults to true.
refresh_topics_interval_seconds int
Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
sync_group_offsets_enabled bool
Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to _consumeroffsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster.
sync_group_offsets_interval_seconds int
Frequency at which consumer group offsets are synced (default: 60, every minute). Example: 60.
sync_topic_configs_enabled bool
Whether to periodically configure remote topics to match their corresponding upstream topics.
tasks_max_per_cpu int
tasks.max is set to this multiplied by the number of CPUs in the service. Default: 1.
adminTimeoutMs Number
Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
emitCheckpointsEnabled Boolean
Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
emitCheckpointsIntervalSeconds Number
Frequency at which consumer group offset checkpoints are emitted (default: 60, every minute). Example: 60.
groups String
Consumer groups to replicate. Supports comma-separated group IDs and regexes. Example: .*.
groupsExclude String
Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example: console-consumer-.*,connect-.*,__.*.
offsetLagMax Number
How out-of-sync a remote partition can be before it is resynced. Example: 100.
refreshGroupsEnabled Boolean
Whether to periodically check for new consumer groups. Defaults to true.
refreshGroupsIntervalSeconds Number
Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
refreshTopicsEnabled Boolean
Whether to periodically check for new topics and partitions. Defaults to true.
refreshTopicsIntervalSeconds Number
Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
syncGroupOffsetsEnabled Boolean
Whether to periodically write the translated offsets of replicated consumer groups (in the source cluster) to _consumeroffsets topic in target cluster, as long as no active consumers in that group are connected to the target cluster.
syncGroupOffsetsIntervalSeconds Number
Frequency at which consumer group offsets are synced (default: 60, every minute). Example: 60.
syncTopicConfigsEnabled Boolean
Whether to periodically configure remote topics to match their corresponding upstream topics.
tasksMaxPerCpu Number
tasks.max is set to this multiplied by the number of CPUs in the service. Default: 1.

KafkaMirrorMakerServiceIntegration
, KafkaMirrorMakerServiceIntegrationArgs

IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
IntegrationType This property is required. string
Type of the service integration
SourceServiceName This property is required. string
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service
integrationType This property is required. string
Type of the service integration
sourceServiceName This property is required. string
Name of the source service
integration_type This property is required. str
Type of the service integration
source_service_name This property is required. str
Name of the source service
integrationType This property is required. String
Type of the service integration
sourceServiceName This property is required. String
Name of the source service

KafkaMirrorMakerTag
, KafkaMirrorMakerTagArgs

Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
Key This property is required. string
Service tag key
Value This property is required. string
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value
key This property is required. string
Service tag key
value This property is required. string
Service tag value
key This property is required. str
Service tag key
value This property is required. str
Service tag value
key This property is required. String
Service tag key
value This property is required. String
Service tag value

KafkaMirrorMakerTechEmail
, KafkaMirrorMakerTechEmailArgs

Email This property is required. string
An email address to contact for technical issues
Email This property is required. string
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues
email This property is required. string
An email address to contact for technical issues
email This property is required. str
An email address to contact for technical issues
email This property is required. String
An email address to contact for technical issues

Import

$ pulumi import aiven:index/kafkaMirrorMaker:KafkaMirrorMaker example_mirrormaker PROJECT/SERVICE_NAME
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