Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

KafkaMirrorMaker

# Kafka MirrorMaker Resource

The Kafka MirrorMaker resource allows the creation and management of Aiven Kafka MirrorMaker 2 services.

Example Usage

using Pulumi;
using Aiven = Pulumi.Aiven;

class MyStack : Stack
{
    public MyStack()
    {
        var mm1 = new Aiven.KafkaMirrorMaker("mm1", new Aiven.KafkaMirrorMakerArgs
        {
            Project = data.Aiven_project.Pr1.Project,
            CloudName = "google-europe-west1",
            Plan = "startup-4",
            ServiceName = "my-mm1",
            KafkaMirrormakerUserConfig = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs
            {
                IpFilters = 
                {
                    "0.0.0.0/0",
                },
                KafkaMirrormaker = new Aiven.Inputs.KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs
                {
                    RefreshGroupsIntervalSeconds = "600",
                    RefreshTopicsEnabled = "true",
                    RefreshTopicsIntervalSeconds = "600",
                },
            },
        });
    }

}
package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := aiven.NewKafkaMirrorMaker(ctx, "mm1", &aiven.KafkaMirrorMakerArgs{
            Project:     pulumi.Any(data.Aiven_project.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.String("600"),
                    RefreshTopicsEnabled:         pulumi.String("true"),
                    RefreshTopicsIntervalSeconds: pulumi.String("600"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_aiven as aiven

mm1 = aiven.KafkaMirrorMaker("mm1",
    project=data["aiven_project"]["pr1"]["project"],
    cloud_name="google-europe-west1",
    plan="startup-4",
    service_name="my-mm1",
    kafka_mirrormaker_user_config=aiven.KafkaMirrorMakerKafkaMirrormakerUserConfigArgs(
        ip_filters=["0.0.0.0/0"],
        kafka_mirrormaker={
            "refreshGroupsIntervalSeconds": 600,
            "refreshTopicsEnabled": True,
            "refreshTopicsIntervalSeconds": 600,
        },
    ))
import * as pulumi from "@pulumi/pulumi";
import * as aiven from "@pulumi/aiven";

const mm1 = new aiven.KafkaMirrorMaker("mm1", {
    project: data.aiven_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 a KafkaMirrorMaker Resource

new KafkaMirrorMaker(name: string, args: KafkaMirrorMakerArgs, opts?: CustomResourceOptions);
def KafkaMirrorMaker(resource_name: str, opts: Optional[ResourceOptions] = None, cloud_name: Optional[str] = None, kafka_mirrormaker: Optional[KafkaMirrorMakerKafkaMirrormakerArgs] = 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_integrations: Optional[Sequence[KafkaMirrorMakerServiceIntegrationArgs]] = None, service_name: Optional[str] = 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)
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.
opts ResourceOptions
A bag of options that control this 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.

KafkaMirrorMaker Resource Properties

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

Inputs

The KafkaMirrorMaker resource accepts the following input properties:

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

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

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

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerArgs

Kafka MirrorMaker configuration values

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfigArgs

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceIntegrations List<KafkaMirrorMakerServiceIntegrationArgs>

Service integrations to specify when creating a service. Not applied after initial service creation

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

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

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

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormaker

Kafka MirrorMaker configuration values

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

ProjectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceIntegrations []KafkaMirrorMakerServiceIntegration

Service integrations to specify when creating a service. Not applied after initial service creation

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

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

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

kafkaMirrormaker KafkaMirrorMakerKafkaMirrormaker

Kafka MirrorMaker configuration values

kafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

maintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

projectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceIntegrations KafkaMirrorMakerServiceIntegration[]

Service integrations to specify when creating a service. Not applied after initial service creation

terminationProtection boolean

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

project str

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

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.

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.

kafka_mirrormaker KafkaMirrorMakerKafkaMirrormakerArgs

Kafka MirrorMaker configuration values

kafka_mirrormaker_user_config KafkaMirrorMakerKafkaMirrormakerUserConfigArgs

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

maintenance_window_dow str

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenance_window_time str

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan str

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project_vpc_id str

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

service_integrations Sequence[KafkaMirrorMakerServiceIntegrationArgs]

Service integrations to specify when creating a service. Not applied after initial service creation

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.

Outputs

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

Components List<KafkaMirrorMakerComponent>

Service component information objects

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string

Kafka MirrorMaker 2 hostname.

ServicePassword string

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

ServicePort int

Kafka MirrorMaker 2 port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Kafka MirrorMaker 2 service.

ServiceUsername string

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

State string

Service state.

Components []KafkaMirrorMakerComponent

Service component information objects

Id string
The provider-assigned unique ID for this managed resource.
ServiceHost string

Kafka MirrorMaker 2 hostname.

ServicePassword string

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

ServicePort int

Kafka MirrorMaker 2 port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Kafka MirrorMaker 2 service.

ServiceUsername string

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

State string

Service state.

components KafkaMirrorMakerComponent[]

Service component information objects

id string
The provider-assigned unique ID for this managed resource.
serviceHost string

Kafka MirrorMaker 2 hostname.

servicePassword string

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

servicePort number

Kafka MirrorMaker 2 port.

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the Kafka MirrorMaker 2 service.

serviceUsername string

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

state string

Service state.

components Sequence[KafkaMirrorMakerComponent]

Service component information objects

id str
The provider-assigned unique ID for this managed resource.
service_host str

Kafka MirrorMaker 2 hostname.

service_password str

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

service_port int

Kafka MirrorMaker 2 port.

service_type str

Aiven internal service type code

service_uri str

URI for connecting to the Kafka MirrorMaker 2 service.

service_username str

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

state str

Service state.

Look up an 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, cloud_name: Optional[str] = None, components: Optional[Sequence[KafkaMirrorMakerComponentArgs]] = None, kafka_mirrormaker: Optional[KafkaMirrorMakerKafkaMirrormakerArgs] = 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, 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)
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.

The following state arguments are supported:

CloudName 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<KafkaMirrorMakerComponentArgs>

Service component information objects

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerArgs

Kafka MirrorMaker configuration values

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfigArgs

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ProjectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

Kafka MirrorMaker 2 hostname.

ServiceIntegrations List<KafkaMirrorMakerServiceIntegrationArgs>

Service integrations to specify when creating a service. Not applied after initial service creation

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

ServicePassword string

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

ServicePort int

Kafka MirrorMaker 2 port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Kafka MirrorMaker 2 service.

ServiceUsername string

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

State string

Service state.

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

CloudName 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 []KafkaMirrorMakerComponent

Service component information objects

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormaker

Kafka MirrorMaker configuration values

KafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

MaintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

Plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

Project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

ProjectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceHost string

Kafka MirrorMaker 2 hostname.

ServiceIntegrations []KafkaMirrorMakerServiceIntegration

Service integrations to specify when creating a service. Not applied after initial service creation

ServiceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

ServicePassword string

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

ServicePort int

Kafka MirrorMaker 2 port.

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the Kafka MirrorMaker 2 service.

ServiceUsername string

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

State string

Service state.

TerminationProtection bool

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

cloudName 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 KafkaMirrorMakerComponent[]

Service component information objects

kafkaMirrormaker KafkaMirrorMakerKafkaMirrormaker

Kafka MirrorMaker configuration values

kafkaMirrormakerUserConfig KafkaMirrorMakerKafkaMirrormakerUserConfig

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

maintenanceWindowDow string

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenanceWindowTime string

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan string

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project string

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

projectVpcId string

optionally 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 as shown above to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

serviceHost string

Kafka MirrorMaker 2 hostname.

serviceIntegrations KafkaMirrorMakerServiceIntegration[]

Service integrations to specify when creating a service. Not applied after initial service creation

serviceName string

specifies the actual name of the service. The name cannot be changed later without destroying and re-creating the service so name should be picked based on intended service usage rather than current attributes.

servicePassword string

Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.

servicePort number

Kafka MirrorMaker 2 port.

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the Kafka MirrorMaker 2 service.

serviceUsername string

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

state string

Service state.

terminationProtection boolean

prevents the service from being deleted. It is recommended to set this to true for all production services to prevent unintentional service deletion. This does not shield against deleting databases or topics but for services with backups much of the content can at least be restored from backup in case accidental deletion is done.

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[KafkaMirrorMakerComponentArgs]

Service component information objects

kafka_mirrormaker KafkaMirrorMakerKafkaMirrormakerArgs

Kafka MirrorMaker configuration values

kafka_mirrormaker_user_config KafkaMirrorMakerKafkaMirrormakerUserConfigArgs

defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:

maintenance_window_dow str

day of week when maintenance operations should be performed. On monday, tuesday, wednesday, etc.

maintenance_window_time str

time of day when maintenance operations should be performed. UTC time in HH:mm:ss format.

plan str

defines what kind of computing resources are allocated for the service. It can be changed after creation, though there are some restrictions when going to a smaller plan such as the new plan must have sufficient amount of disk space to store all current data and switching to a plan with fewer nodes might not be supported. The basic plan names are hobbyist, startup-x, business-x and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The exact options can be seen from the Aiven web console’s Create Service dialog.

project str

identifies the project the service belongs to. To set up proper dependency between the project and the service, refer to the project as shown in the above example. Project cannot be changed later without destroying and re-creating the service.

project_vpc_id str

optionally 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 as shown above 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

Kafka MirrorMaker 2 hostname.

service_integrations Sequence[KafkaMirrorMakerServiceIntegrationArgs]

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 Kafka MirrorMaker 2 service, if applicable.

service_port int

Kafka MirrorMaker 2 port.

service_type str

Aiven internal service type code

service_uri str

URI for connecting to the Kafka MirrorMaker 2 service.

service_username str

Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.

state str

Service state.

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.

Supporting Types

KafkaMirrorMakerComponent

Component string
Host string
KafkaAuthenticationMethod string
Port int
Route string
Ssl bool
Usage string
Component string
Host string
KafkaAuthenticationMethod string
Port int
Route string
Ssl bool
Usage string
component string
host string
kafkaAuthenticationMethod string
port number
route string
ssl boolean
usage string

KafkaMirrorMakerKafkaMirrormakerUserConfig

IpFilters List<string>

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs

Kafka MirrorMaker configuration values

IpFilters []string

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

KafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker

Kafka MirrorMaker configuration values

ipFilters string[]

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

kafkaMirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker

Kafka MirrorMaker configuration values

ip_filters Sequence[str]

allow incoming connections from CIDR address block, e.g. 10.20.0.0/16

kafka_mirrormaker KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormakerArgs

Kafka MirrorMaker configuration values

KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker

RefreshGroupsEnabled string

Whether to periodically check for new consumer groups. Defaults to ‘true’.

RefreshGroupsIntervalSeconds string

Whether to periodically check for new topics and partitions. Defaults to ‘true’.

RefreshTopicsEnabled string
RefreshTopicsIntervalSeconds string

Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).

RefreshGroupsEnabled string

Whether to periodically check for new consumer groups. Defaults to ‘true’.

RefreshGroupsIntervalSeconds string

Whether to periodically check for new topics and partitions. Defaults to ‘true’.

RefreshTopicsEnabled string
RefreshTopicsIntervalSeconds string

Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).

refreshGroupsEnabled string

Whether to periodically check for new consumer groups. Defaults to ‘true’.

refreshGroupsIntervalSeconds string

Whether to periodically check for new topics and partitions. Defaults to ‘true’.

refreshTopicsEnabled string
refreshTopicsIntervalSeconds string

Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).

refresh_groups_enabled str

Whether to periodically check for new consumer groups. Defaults to ‘true’.

refresh_groups_interval_seconds str

Whether to periodically check for new topics and partitions. Defaults to ‘true’.

refresh_topics_enabled str
refresh_topics_interval_seconds str

Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).

KafkaMirrorMakerServiceIntegration

Package Details

Repository
https://github.com/pulumi/pulumi-aiven
License
Apache-2.0
Notes
This Pulumi package is based on the aiven Terraform Provider.