aiven.KafkaMirrorMaker
Explore with Pulumi AI
The Kafka MirrorMaker resource allows the creation and management of Aiven Kafka MirrorMaker 2 services.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";
const mm1 = new aiven.KafkaMirrorMaker("mm1", {
project: pr1.project,
cloudName: "google-europe-west1",
plan: "startup-4",
serviceName: "my-mm1",
kafkaMirrormakerUserConfig: {
ipFilters: ["0.0.0.0/0"],
kafkaMirrormaker: {
refreshGroupsIntervalSeconds: 600,
refreshTopicsEnabled: true,
refreshTopicsIntervalSeconds: 600,
},
},
});
import pulumi
import pulumi_aiven as aiven
mm1 = aiven.KafkaMirrorMaker("mm1",
project=pr1["project"],
cloud_name="google-europe-west1",
plan="startup-4",
service_name="my-mm1",
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,
},
})
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, "mm1", &aiven.KafkaMirrorMakerArgs{
Project: pulumi.Any(pr1.Project),
CloudName: pulumi.String("google-europe-west1"),
Plan: pulumi.String("startup-4"),
ServiceName: pulumi.String("my-mm1"),
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
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;
return await Deployment.RunAsync(() =>
{
var mm1 = new Aiven.KafkaMirrorMaker("mm1", new()
{
Project = pr1.Project,
CloudName = "google-europe-west1",
Plan = "startup-4",
ServiceName = "my-mm1",
KafkaMirrormakerUserConfig = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
{
IpFilters = new[]
{
"0.0.0.0/0",
},
KafkaMirrormaker = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs
{
RefreshGroupsIntervalSeconds = 600,
RefreshTopicsEnabled = true,
RefreshTopicsIntervalSeconds = 600,
},
},
});
});
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 mm1 = new KafkaMirrorMaker("mm1", KafkaMirrorMakerArgs.builder()
.project(pr1.project())
.cloudName("google-europe-west1")
.plan("startup-4")
.serviceName("my-mm1")
.kafkaMirrormakerUserConfig(KafkaMirrorMakerKafkaMirrormakerUserConfigArgs.builder()
.ipFilters("0.0.0.0/0")
.kafkaMirrormaker(KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs.builder()
.refreshGroupsIntervalSeconds(600)
.refreshTopicsEnabled(true)
.refreshTopicsIntervalSeconds(600)
.build())
.build())
.build());
}
}
resources:
mm1:
type: aiven:KafkaMirrorMaker
properties:
project: ${pr1.project}
cloudName: google-europe-west1
plan: startup-4
serviceName: my-mm1
kafkaMirrormakerUserConfig:
ipFilters:
- 0.0.0.0/0
kafkaMirrormaker:
refreshGroupsIntervalSeconds: 600
refreshTopicsEnabled: true
refreshTopicsIntervalSeconds: 600
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 string
- The unique name of the resource.
- args KafkaMirrorMakerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args KafkaMirrorMakerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KafkaMirrorMakerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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,
});
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),
})
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());
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)
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,
});
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
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 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
andpremium-x
wherex
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 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.
- Service
Name 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.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Disk
Space 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.
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config - 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 stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 List<KafkaMirror Maker Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips 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
- List<Kafka
Mirror Maker Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<KafkaMirror Maker Tech Email> - 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 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
andpremium-x
wherex
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 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.
- Service
Name 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.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Disk
Space 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.
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config Args - 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 stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- Project
Vpc stringId - 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 []KafkaMirror Maker Service Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Static
Ips []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
- []Kafka
Mirror Maker Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []KafkaMirror Maker Tech Email Args - 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 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
andpremium-x
wherex
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 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.
- service
Name 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - disk
Space 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.
- kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config - 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 StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<KafkaMirror Maker Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Kafka
Mirror Maker Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<KafkaMirror Maker Tech Email> - 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 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 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
andpremium-x
wherex
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 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.
- service
Name 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.
- additional
Disk stringSpace - 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 with no HA capabilities.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - disk
Space 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.
- kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config - 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 stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc stringId - 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 KafkaMirror Maker Service Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- Kafka
Mirror Maker Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails KafkaMirror Maker Tech Email[] - 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 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 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
andpremium-x
wherex
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 str
- The name of the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. Changing this property forces recreation of the resource.
- service_
name str - 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_ strspace - 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 with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - 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.
- kafka_
mirrormaker_ Kafkauser_ config Mirror Maker Kafka Mirrormaker User Config Args - 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_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project_
vpc_ strid - 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[KafkaMirror Maker Service Integration Args] - 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
- Sequence[Kafka
Mirror Maker Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[KafkaMirror Maker Tech Email Args] - 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 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
andpremium-x
wherex
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 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.
- service
Name 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - disk
Space 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.
- kafka
Mirrormaker Property MapUser Config - 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 StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - Time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.
- project
Vpc StringId - 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 List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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<Kafka
Mirror Maker Component> - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Components
[]Kafka
Mirror Maker Component - Service component information objects
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string - The hostname of the service.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
List<Kafka
Mirror Maker Component> - Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Kafka
Mirror Maker Component[] - Service component information objects
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string - The hostname of the service.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components
Sequence[Kafka
Mirror Maker Component] - Service component information objects
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- 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
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- components List<Property Map>
- Service component information objects
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- id String
- The provider-assigned unique ID for this managed resource.
- service
Host String - The hostname of the service.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
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)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
List<Kafka
Mirror Maker Component> - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config - 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 stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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 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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations List<KafkaMirror Maker Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips 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
- List<Kafka
Mirror Maker Tag> - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails List<KafkaMirror Maker Tech Email> - 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.
- Additional
Disk stringSpace - 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 with no HA capabilities.
- Cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - Components
[]Kafka
Mirror Maker Component Args - Service component information objects
- Disk
Space 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.
- Disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- Disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - Disk
Space stringUsed - Disk space that service is currently using
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config Args - 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 stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- Maintenance
Window stringTime - 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
andpremium-x
wherex
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 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.
- Project
Vpc stringId - 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 string - The hostname of the service.
- Service
Integrations []KafkaMirror Maker Service Integration Args - Service integrations to specify when creating a service. Not applied after initial service creation
- Service
Name 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.
- Service
Password string - Password used for connecting to the service, if applicable
- Service
Port int - The port of the service
- Service
Type string - Aiven internal service type code
- Service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- Service
Username string - Username used for connecting to the service, if applicable
- State string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- Static
Ips []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
- []Kafka
Mirror Maker Tag Args - Tags are key-value pairs that allow you to categorize services.
- Tech
Emails []KafkaMirror Maker Tech Email Args - 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
List<Kafka
Mirror Maker Component> - Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config - 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 StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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 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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<KafkaMirror Maker Service Integration> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Integer - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Kafka
Mirror Maker Tag> - Tags are key-value pairs that allow you to categorize services.
- tech
Emails List<KafkaMirror Maker Tech Email> - 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 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 stringSpace - 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 with no HA capabilities.
- cloud
Name string - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Kafka
Mirror Maker Component[] - Service component information objects
- disk
Space 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.
- disk
Space stringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space stringDefault - 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 stringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space stringUsed - Disk space that service is currently using
- kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config - 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 stringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window stringTime - 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
andpremium-x
wherex
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 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.
- project
Vpc stringId - 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 string - The hostname of the service.
- service
Integrations KafkaMirror Maker Service Integration[] - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password string - Password used for connecting to the service, if applicable
- service
Port number - The port of the service
- service
Type string - Aiven internal service type code
- service
Uri string - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username string - Username used for connecting to the service, if applicable
- state string
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- Kafka
Mirror Maker Tag[] - Tags are key-value pairs that allow you to categorize services.
- tech
Emails KafkaMirror Maker Tech Email[] - 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 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_ strspace - 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 with no HA capabilities.
- cloud_
name str - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components
Sequence[Kafka
Mirror Maker Component Args] - 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.
- disk_
space_ strcap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk_
space_ strdefault - 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_ strstep - 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 fromdisk_space_default
by increments of this size. - disk_
space_ strused - Disk space that service is currently using
- kafka_
mirrormaker_ Kafkauser_ config Mirror Maker Kafka Mirrormaker User Config Args - 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_ strdow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance_
window_ strtime - 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
andpremium-x
wherex
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 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_ strid - 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[KafkaMirror Maker Service Integration Args] - Service integrations to specify when creating a service. Not applied after initial service creation
- service_
name 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
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- 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
- Sequence[Kafka
Mirror Maker Tag Args] - Tags are key-value pairs that allow you to categorize services.
- tech_
emails Sequence[KafkaMirror Maker Tech Email Args] - 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.
- additional
Disk StringSpace - 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 with no HA capabilities.
- cloud
Name String - Defines where the cloud provider and region where the service is hosted in. This can be changed freely after service is created. Changing the value will trigger a potentially lengthy migration process for the service. Format is cloud provider name (
aws
,azure
,do
google
,upcloud
, etc.), dash, and the cloud provider specific region name. These are documented on each Cloud provider's own support articles, like here for Google and here for AWS. - components List<Property Map>
- Service component information objects
- disk
Space 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.
- disk
Space StringCap - The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
- disk
Space StringDefault - 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 StringStep - 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 fromdisk_space_default
by increments of this size. - disk
Space StringUsed - Disk space that service is currently using
- kafka
Mirrormaker Property MapUser Config - 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 StringDow - Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.
- maintenance
Window StringTime - 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
andpremium-x
wherex
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 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.
- project
Vpc StringId - 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 String - The hostname of the service.
- service
Integrations List<Property Map> - Service integrations to specify when creating a service. Not applied after initial service creation
- service
Name 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.
- service
Password String - Password used for connecting to the service, if applicable
- service
Port Number - The port of the service
- service
Type String - Aiven internal service type code
- service
Uri String - URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
- service
Username String - Username used for connecting to the service, if applicable
- state String
- Service state. One of
POWEROFF
,REBALANCING
,REBUILDING
orRUNNING
- static
Ips 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
- List<Property Map>
- Tags are key-value pairs that allow you to categorize services.
- tech
Emails 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.
- termination
Protection 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
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- Connection
Uri 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
- Kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- connection
Uri 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
- kafka
Authentication stringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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_ strmethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- connection
Uri 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
- kafka
Authentication StringMethod - Kafka authentication method. This is a value specific to the 'kafka' service component
- 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
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Ip
Filter List<KafkaObjects Mirror Maker Kafka Mirrormaker User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter List<string>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters List<string> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker User Config Kafka Mirrormaker - 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.
- Additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- Ip
Filter []KafkaObjects Mirror Maker Kafka Mirrormaker User Config Ip Filter Object - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- Ip
Filter []stringStrings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Ip
Filters []string - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - Kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker User Config Kafka Mirrormaker - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- ip
Filter List<KafkaObjects Mirror Maker Kafka Mirrormaker User Config Ip Filter Object> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker User Config Kafka Mirrormaker - Kafka MirrorMaker configuration values
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- static
Ips Boolean - Use static public IP addresses.
- additional
Backup stringRegions - Additional Cloud Regions for Backup Replication.
- ip
Filter KafkaObjects Mirror Maker Kafka Mirrormaker User Config Ip Filter Object[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter string[]Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters string[] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker User Config Kafka Mirrormaker - Kafka MirrorMaker configuration values
- service
Log boolean - Store logs for the service so that they are available in the HTTP API and console.
- static
Ips boolean - Use static public IP addresses.
- additional_
backup_ strregions - Additional Cloud Regions for Backup Replication.
- ip_
filter_ Sequence[Kafkaobjects Mirror Maker Kafka Mirrormaker User Config Ip Filter Object] - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip_
filter_ Sequence[str]strings - 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
. - kafka_
mirrormaker KafkaMirror Maker Kafka Mirrormaker User Config Kafka Mirrormaker - 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.
- additional
Backup StringRegions - Additional Cloud Regions for Backup Replication.
- ip
Filter List<Property Map>Objects - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
- ip
Filter List<String>Strings - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - ip
Filters List<String> - Allow incoming connections from CIDR address block, e.g.
10.20.0.0/16
. - kafka
Mirrormaker Property Map - Kafka MirrorMaker configuration values
- service
Log Boolean - Store logs for the service so that they are available in the HTTP API and console.
- static
Ips Boolean - Use static public IP addresses.
KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObject, KafkaMirrorMakerKafkaMirrormakerUserConfigIpFilterObjectArgs
- Network string
- CIDR address block. Example:
10.20.0.0/16
. - Description string
- Description for IP filter list entry. Example:
Production service IP range
.
- Network string
- CIDR address block. Example:
10.20.0.0/16
. - Description string
- Description for IP filter list entry. Example:
Production service IP range
.
- network String
- CIDR address block. Example:
10.20.0.0/16
. - description String
- Description for IP filter list entry. Example:
Production service IP range
.
- network string
- CIDR address block. Example:
10.20.0.0/16
. - description string
- Description for IP filter list entry. Example:
Production service IP range
.
- network str
- CIDR address block. Example:
10.20.0.0/16
. - description str
- Description for IP filter list entry. Example:
Production service IP range
.
- network 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
- Admin
Timeout intMs - Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
- Emit
Checkpoints boolEnabled - Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
- Emit
Checkpoints intInterval Seconds - 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:
.*
. - Groups
Exclude string - Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example:
console-consumer-.*,connect-.*,__.*
. - Offset
Lag intMax - How out-of-sync a remote partition can be before it is resynced. Example:
100
. - Refresh
Groups boolEnabled - Whether to periodically check for new consumer groups. Defaults to
true
. - Refresh
Groups intInterval Seconds - Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
- Refresh
Topics boolEnabled - Whether to periodically check for new topics and partitions. Defaults to
true
. - Refresh
Topics intInterval Seconds - Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- Sync
Group boolOffsets Enabled - 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 intOffsets Interval Seconds - Frequency at which consumer group offsets are synced (default: 60, every minute). Example:
60
. - Sync
Topic boolConfigs Enabled - Whether to periodically configure remote topics to match their corresponding upstream topics.
- Tasks
Max intPer Cpu tasks.max
is set to this multiplied by the number of CPUs in the service. Default:1
.
- Admin
Timeout intMs - Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
- Emit
Checkpoints boolEnabled - Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
- Emit
Checkpoints intInterval Seconds - 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:
.*
. - Groups
Exclude string - Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example:
console-consumer-.*,connect-.*,__.*
. - Offset
Lag intMax - How out-of-sync a remote partition can be before it is resynced. Example:
100
. - Refresh
Groups boolEnabled - Whether to periodically check for new consumer groups. Defaults to
true
. - Refresh
Groups intInterval Seconds - Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
- Refresh
Topics boolEnabled - Whether to periodically check for new topics and partitions. Defaults to
true
. - Refresh
Topics intInterval Seconds - Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- Sync
Group boolOffsets Enabled - 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 intOffsets Interval Seconds - Frequency at which consumer group offsets are synced (default: 60, every minute). Example:
60
. - Sync
Topic boolConfigs Enabled - Whether to periodically configure remote topics to match their corresponding upstream topics.
- Tasks
Max intPer Cpu tasks.max
is set to this multiplied by the number of CPUs in the service. Default:1
.
- admin
Timeout IntegerMs - Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
- emit
Checkpoints BooleanEnabled - Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
- emit
Checkpoints IntegerInterval Seconds - 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:
.*
. - groups
Exclude String - Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example:
console-consumer-.*,connect-.*,__.*
. - offset
Lag IntegerMax - How out-of-sync a remote partition can be before it is resynced. Example:
100
. - refresh
Groups BooleanEnabled - Whether to periodically check for new consumer groups. Defaults to
true
. - refresh
Groups IntegerInterval Seconds - Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
- refresh
Topics BooleanEnabled - Whether to periodically check for new topics and partitions. Defaults to
true
. - refresh
Topics IntegerInterval Seconds - Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- sync
Group BooleanOffsets Enabled - 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 IntegerOffsets Interval Seconds - Frequency at which consumer group offsets are synced (default: 60, every minute). Example:
60
. - sync
Topic BooleanConfigs Enabled - Whether to periodically configure remote topics to match their corresponding upstream topics.
- tasks
Max IntegerPer Cpu tasks.max
is set to this multiplied by the number of CPUs in the service. Default:1
.
- admin
Timeout numberMs - Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
- emit
Checkpoints booleanEnabled - Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
- emit
Checkpoints numberInterval Seconds - 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:
.*
. - groups
Exclude string - Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example:
console-consumer-.*,connect-.*,__.*
. - offset
Lag numberMax - How out-of-sync a remote partition can be before it is resynced. Example:
100
. - refresh
Groups booleanEnabled - Whether to periodically check for new consumer groups. Defaults to
true
. - refresh
Groups numberInterval Seconds - Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
- refresh
Topics booleanEnabled - Whether to periodically check for new topics and partitions. Defaults to
true
. - refresh
Topics numberInterval Seconds - Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- sync
Group booleanOffsets Enabled - 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 numberOffsets Interval Seconds - Frequency at which consumer group offsets are synced (default: 60, every minute). Example:
60
. - sync
Topic booleanConfigs Enabled - Whether to periodically configure remote topics to match their corresponding upstream topics.
- tasks
Max numberPer Cpu tasks.max
is set to this multiplied by the number of CPUs in the service. Default:1
.
- admin_
timeout_ intms - Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
- emit_
checkpoints_ boolenabled - Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
- emit_
checkpoints_ intinterval_ seconds - 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_ intmax - How out-of-sync a remote partition can be before it is resynced. Example:
100
. - refresh_
groups_ boolenabled - Whether to periodically check for new consumer groups. Defaults to
true
. - refresh_
groups_ intinterval_ seconds - Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
- refresh_
topics_ boolenabled - Whether to periodically check for new topics and partitions. Defaults to
true
. - refresh_
topics_ intinterval_ seconds - Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- sync_
group_ booloffsets_ enabled - 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_ intoffsets_ interval_ seconds - Frequency at which consumer group offsets are synced (default: 60, every minute). Example:
60
. - sync_
topic_ boolconfigs_ enabled - Whether to periodically configure remote topics to match their corresponding upstream topics.
- tasks_
max_ intper_ cpu tasks.max
is set to this multiplied by the number of CPUs in the service. Default:1
.
- admin
Timeout NumberMs - Timeout for administrative tasks, e.g. detecting new topics, loading of consumer group and offsets. Defaults to 60000 milliseconds (1 minute).
- emit
Checkpoints BooleanEnabled - Whether to emit consumer group offset checkpoints to target cluster periodically (default: true).
- emit
Checkpoints NumberInterval Seconds - 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:
.*
. - groups
Exclude String - Exclude groups. Supports comma-separated group IDs and regexes. Excludes take precedence over includes. Example:
console-consumer-.*,connect-.*,__.*
. - offset
Lag NumberMax - How out-of-sync a remote partition can be before it is resynced. Example:
100
. - refresh
Groups BooleanEnabled - Whether to periodically check for new consumer groups. Defaults to
true
. - refresh
Groups NumberInterval Seconds - Frequency of consumer group refresh in seconds. Defaults to 600 seconds (10 minutes).
- refresh
Topics BooleanEnabled - Whether to periodically check for new topics and partitions. Defaults to
true
. - refresh
Topics NumberInterval Seconds - Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- sync
Group BooleanOffsets Enabled - 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 NumberOffsets Interval Seconds - Frequency at which consumer group offsets are synced (default: 60, every minute). Example:
60
. - sync
Topic BooleanConfigs Enabled - Whether to periodically configure remote topics to match their corresponding upstream topics.
- tasks
Max NumberPer Cpu tasks.max
is set to this multiplied by the number of CPUs in the service. Default:1
.
KafkaMirrorMakerServiceIntegration, KafkaMirrorMakerServiceIntegrationArgs
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- Integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- Source
Service stringName - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
- integration
Type string - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service stringName - Name of the source service
- integration_
type str - Type of the service integration. The only supported value at the moment is
read_replica
- source_
service_ strname - Name of the source service
- integration
Type String - Type of the service integration. The only supported value at the moment is
read_replica
- source
Service StringName - Name of the source service
KafkaMirrorMakerTag, KafkaMirrorMakerTagArgs
KafkaMirrorMakerTechEmail, KafkaMirrorMakerTechEmailArgs
- Email string
- An email address to contact for technical issues
- Email string
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
- email string
- An email address to contact for technical issues
- email str
- An email address to contact for technical issues
- email String
- An email address to contact for technical issues
Import
$ pulumi import aiven:index/kafkaMirrorMaker:KafkaMirrorMaker mm1 project/service_name
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.