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.
- 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.
- 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.- Kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker Args Kafka MirrorMaker configuration values
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config Args defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On 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 exact options can be seen from the Aiven web console’s Create Service dialog.- Project
Vpc stringId 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 List<KafkaMirror Maker Service Integration Args> 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.
- 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.
- 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.
- 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.- Kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker Kafka MirrorMaker configuration values
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On 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 exact options can be seen from the Aiven web console’s Create Service dialog.- Project
Vpc stringId 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 []KafkaMirror Maker Service Integration 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.
- 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.
- 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.
- 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.- kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker Kafka MirrorMaker configuration values
- kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- maintenance
Window stringDow day of week when maintenance operations should be performed. On 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 exact options can be seen from the Aiven web console’s Create Service dialog.- project
Vpc stringId 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 KafkaMirror Maker Service Integration[] Service integrations to specify when creating a service. Not applied after initial service creation
- 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.
- 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 KafkaMirror Maker Kafka Mirrormaker Args Kafka MirrorMaker configuration values
- kafka_
mirrormaker_ Kafkauser_ config Mirror Maker Kafka Mirrormaker User Config Args defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- maintenance_
window_ strdow day of week when maintenance operations should be performed. On 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 exact options can be seen from the Aiven web console’s Create Service dialog.- project_
vpc_ strid 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[KafkaMirror Maker Service Integration Args] 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<Kafka
Mirror Maker Component> Service component information objects
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string Kafka MirrorMaker 2 hostname.
- Service
Password string Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- Service
Port int Kafka MirrorMaker 2 port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the Kafka MirrorMaker 2 service.
- Service
Username string Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- State string
Service state.
- Components
[]Kafka
Mirror Maker Component Service component information objects
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Host string Kafka MirrorMaker 2 hostname.
- Service
Password string Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- Service
Port int Kafka MirrorMaker 2 port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the Kafka MirrorMaker 2 service.
- Service
Username string Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- State string
Service state.
- components
Kafka
Mirror Maker Component[] Service component information objects
- id string
- The provider-assigned unique ID for this managed resource.
- service
Host string Kafka MirrorMaker 2 hostname.
- service
Password string Password used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- service
Port number Kafka MirrorMaker 2 port.
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the Kafka MirrorMaker 2 service.
- service
Username string Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- state string
Service state.
- components
Sequence[Kafka
Mirror Maker Component] 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:
- 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 Args> Service component information objects
- Kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker Args Kafka MirrorMaker configuration values
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config Args defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On 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 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.
- Project
Vpc stringId 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 string Kafka MirrorMaker 2 hostname.
- Service
Integrations List<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 Kafka MirrorMaker 2 service, if applicable.
- Service
Port int Kafka MirrorMaker 2 port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the Kafka MirrorMaker 2 service.
- Service
Username string Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- State string
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.
- 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
- Kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker Kafka MirrorMaker configuration values
- Kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- Maintenance
Window stringDow day of week when maintenance operations should be performed. On 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 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.
- Project
Vpc stringId 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 string Kafka MirrorMaker 2 hostname.
- 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 Kafka MirrorMaker 2 service, if applicable.
- Service
Port int Kafka MirrorMaker 2 port.
- Service
Type string Aiven internal service type code
- Service
Uri string URI for connecting to the Kafka MirrorMaker 2 service.
- Service
Username string Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- State string
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.
- 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
- kafka
Mirrormaker KafkaMirror Maker Kafka Mirrormaker Kafka MirrorMaker configuration values
- kafka
Mirrormaker KafkaUser Config Mirror Maker Kafka Mirrormaker User Config defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- maintenance
Window stringDow day of week when maintenance operations should be performed. On 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 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.
- project
Vpc stringId 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 string Kafka MirrorMaker 2 hostname.
- 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 Kafka MirrorMaker 2 service, if applicable.
- service
Port number Kafka MirrorMaker 2 port.
- service
Type string Aiven internal service type code
- service
Uri string URI for connecting to the Kafka MirrorMaker 2 service.
- service
Username string Username used for connecting to the Kafka MirrorMaker 2 service, if applicable.
- state string
Service state.
- 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.
- 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
- kafka_
mirrormaker KafkaMirror Maker Kafka Mirrormaker Args Kafka MirrorMaker configuration values
- kafka_
mirrormaker_ Kafkauser_ config Mirror Maker Kafka Mirrormaker User Config Args defines Kafka MirrorMaker 2 specific additional configuration options. The following configuration options available:
- maintenance_
window_ strdow day of week when maintenance operations should be performed. On 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 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_ strid 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[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 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
KafkaMirrorMakerKafkaMirrormakerUserConfig
- 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 Args Kafka MirrorMaker configuration values
- 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
- 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
- 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 Args Kafka MirrorMaker configuration values
KafkaMirrorMakerKafkaMirrormakerUserConfigKafkaMirrormaker
- Refresh
Groups stringEnabled Whether to periodically check for new consumer groups. Defaults to ‘true’.
- Refresh
Groups stringInterval Seconds Whether to periodically check for new topics and partitions. Defaults to ‘true’.
- Refresh
Topics stringEnabled - Refresh
Topics stringInterval Seconds Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- Refresh
Groups stringEnabled Whether to periodically check for new consumer groups. Defaults to ‘true’.
- Refresh
Groups stringInterval Seconds Whether to periodically check for new topics and partitions. Defaults to ‘true’.
- Refresh
Topics stringEnabled - Refresh
Topics stringInterval Seconds Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- refresh
Groups stringEnabled Whether to periodically check for new consumer groups. Defaults to ‘true’.
- refresh
Groups stringInterval Seconds Whether to periodically check for new topics and partitions. Defaults to ‘true’.
- refresh
Topics stringEnabled - refresh
Topics stringInterval Seconds Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
- refresh_
groups_ strenabled Whether to periodically check for new consumer groups. Defaults to ‘true’.
- refresh_
groups_ strinterval_ seconds Whether to periodically check for new topics and partitions. Defaults to ‘true’.
- refresh_
topics_ strenabled - refresh_
topics_ strinterval_ seconds Frequency of topic and partitions refresh in seconds. Defaults to 600 seconds (10 minutes).
KafkaMirrorMakerServiceIntegration
- Integration
Type string - Source
Service stringName
- Integration
Type string - Source
Service stringName
- integration
Type string - source
Service stringName
Package Details
- Repository
- https://github.com/pulumi/pulumi-aiven
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aiven
Terraform Provider.