Aiven v6.7.2, Oct 31 23

Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

aiven.KafkaConnect

Explore with Pulumi AI

Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aiven = Pulumi.Aiven;

return await Deployment.RunAsync(() => 
{
    var kc1 = new Aiven.KafkaConnect("kc1", new()
    {
        Project = data.Aiven_project.Pr1.Project,
        CloudName = "google-europe-west1",
        Plan = "startup-4",
        ServiceName = "my-kc1",
        MaintenanceWindowDow = "monday",
        MaintenanceWindowTime = "10:00:00",
        KafkaConnectUserConfig = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigArgs
        {
            KafkaConnect = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs
            {
                ConsumerIsolationLevel = "read_committed",
            },
            PublicAccess = new Aiven.Inputs.KafkaConnectKafkaConnectUserConfigPublicAccessArgs
            {
                KafkaConnect = true,
            },
        },
    });

});

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.NewKafkaConnect(ctx, "kc1", &aiven.KafkaConnectArgs{
			Project:               pulumi.Any(data.Aiven_project.Pr1.Project),
			CloudName:             pulumi.String("google-europe-west1"),
			Plan:                  pulumi.String("startup-4"),
			ServiceName:           pulumi.String("my-kc1"),
			MaintenanceWindowDow:  pulumi.String("monday"),
			MaintenanceWindowTime: pulumi.String("10:00:00"),
			KafkaConnectUserConfig: &aiven.KafkaConnectKafkaConnectUserConfigArgs{
				KafkaConnect: &aiven.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs{
					ConsumerIsolationLevel: pulumi.String("read_committed"),
				},
				PublicAccess: &aiven.KafkaConnectKafkaConnectUserConfigPublicAccessArgs{
					KafkaConnect: pulumi.Bool(true),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aiven.KafkaConnect;
import com.pulumi.aiven.KafkaConnectArgs;
import com.pulumi.aiven.inputs.KafkaConnectKafkaConnectUserConfigArgs;
import com.pulumi.aiven.inputs.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs;
import com.pulumi.aiven.inputs.KafkaConnectKafkaConnectUserConfigPublicAccessArgs;
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 kc1 = new KafkaConnect("kc1", KafkaConnectArgs.builder()        
            .project(data.aiven_project().pr1().project())
            .cloudName("google-europe-west1")
            .plan("startup-4")
            .serviceName("my-kc1")
            .maintenanceWindowDow("monday")
            .maintenanceWindowTime("10:00:00")
            .kafkaConnectUserConfig(KafkaConnectKafkaConnectUserConfigArgs.builder()
                .kafkaConnect(KafkaConnectKafkaConnectUserConfigKafkaConnectArgs.builder()
                    .consumerIsolationLevel("read_committed")
                    .build())
                .publicAccess(KafkaConnectKafkaConnectUserConfigPublicAccessArgs.builder()
                    .kafkaConnect(true)
                    .build())
                .build())
            .build());

    }
}

import pulumi
import pulumi_aiven as aiven

kc1 = aiven.KafkaConnect("kc1",
    project=data["aiven_project"]["pr1"]["project"],
    cloud_name="google-europe-west1",
    plan="startup-4",
    service_name="my-kc1",
    maintenance_window_dow="monday",
    maintenance_window_time="10:00:00",
    kafka_connect_user_config=aiven.KafkaConnectKafkaConnectUserConfigArgs(
        kafka_connect=aiven.KafkaConnectKafkaConnectUserConfigKafkaConnectArgs(
            consumer_isolation_level="read_committed",
        ),
        public_access=aiven.KafkaConnectKafkaConnectUserConfigPublicAccessArgs(
            kafka_connect=True,
        ),
    ))

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

const kc1 = new aiven.KafkaConnect("kc1", {
    project: data.aiven_project.pr1.project,
    cloudName: "google-europe-west1",
    plan: "startup-4",
    serviceName: "my-kc1",
    maintenanceWindowDow: "monday",
    maintenanceWindowTime: "10:00:00",
    kafkaConnectUserConfig: {
        kafkaConnect: {
            consumerIsolationLevel: "read_committed",
        },
        publicAccess: {
            kafkaConnect: true,
        },
    },
});

resources:
  kc1:
    type: aiven:KafkaConnect
    properties:
      project: ${data.aiven_project.pr1.project}
      cloudName: google-europe-west1
      plan: startup-4
      serviceName: my-kc1
      maintenanceWindowDow: monday
      maintenanceWindowTime: 10:00:00
      kafkaConnectUserConfig:
        kafkaConnect:
          consumerIsolationLevel: read_committed
        publicAccess:
          kafkaConnect: true

Create KafkaConnect Resource

new KafkaConnect(name: string, args: KafkaConnectArgs, opts?: CustomResourceOptions);

@overload
def KafkaConnect(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 additional_disk_space: Optional[str] = None,
                 cloud_name: Optional[str] = None,
                 disk_space: Optional[str] = None,
                 kafka_connect_user_config: Optional[KafkaConnectKafkaConnectUserConfigArgs] = 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[KafkaConnectServiceIntegrationArgs]] = None,
                 service_name: Optional[str] = None,
                 static_ips: Optional[Sequence[str]] = None,
                 tags: Optional[Sequence[KafkaConnectTagArgs]] = None,
                 termination_protection: Optional[bool] = None)
@overload
def KafkaConnect(resource_name: str,
                 args: KafkaConnectArgs,
                 opts: Optional[ResourceOptions] = None)

func NewKafkaConnect(ctx *Context, name string, args KafkaConnectArgs, opts ...ResourceOption) (*KafkaConnect, error)

public KafkaConnect(string name, KafkaConnectArgs args, CustomResourceOptions? opts = null)

public KafkaConnect(String name, KafkaConnectArgs args)
public KafkaConnect(String name, KafkaConnectArgs args, CustomResourceOptions options)

type: aiven:KafkaConnect
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KafkaConnectArgs: 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 KafkaConnectArgs: 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 KafkaConnectArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KafkaConnectArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args KafkaConnectArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

KafkaConnect Resource Properties

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

Inputs

The KafkaConnect 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 and premium-x where x is (roughly) the amount of memory on each node (also other attributes like number of CPUs and amount of disk space varies but naming is based on memory). The available options can be seem from the Aiven pricing page.

Project string

Identifies the project this resource belongs to. To set up proper dependencies please refer to this variable as a reference. This property cannot be changed, doing so forces recreation of the resource.

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.

AdditionalDiskSpace string

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

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.

DiskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig

KafkaConnect user configurable settings

MaintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

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

ProjectVpcId string

Specifies the VPC the service should run in. If the value is not set the service is not run inside a VPC. When set, the value should be given as a reference to set up dependencies correctly and the VPC must be in the same cloud and region as the service itself. Project can be freely moved to and from VPC after creation but doing so triggers migration to new servers so the operation can take significant amount of time to complete if the service has a lot of data.

ServiceIntegrations List<KafkaConnectServiceIntegration>

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

StaticIps List<string>

Static IPs that are going to be associated with this service. Please assign a value using the 'toset' function. Once a static ip resource is in the 'assigned' state it cannot be unbound from the node again

Tags List<KafkaConnectTag>

Tags are key-value pairs that allow you to categorize services.

TerminationProtection bool

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

Plan string

Project string

ServiceName string

AdditionalDiskSpace string

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

CloudName string

DiskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfigArgs

KafkaConnect user configurable settings

MaintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

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

ProjectVpcId string

ServiceIntegrations []KafkaConnectServiceIntegrationArgs

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

StaticIps []string

Tags []KafkaConnectTagArgs

Tags are key-value pairs that allow you to categorize services.

TerminationProtection bool

plan String

project String

serviceName String

additionalDiskSpace String

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloudName String

diskSpace String

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig

KafkaConnect user configurable settings

maintenanceWindowDow String

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime String

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

projectVpcId String

serviceIntegrations List<KafkaConnectServiceIntegration>

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

staticIps List<String>

tags List<KafkaConnectTag>

Tags are key-value pairs that allow you to categorize services.

terminationProtection Boolean

plan string

project string

serviceName string

additionalDiskSpace string

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloudName string

diskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig

KafkaConnect user configurable settings

maintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime string

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

projectVpcId string

serviceIntegrations KafkaConnectServiceIntegration[]

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

staticIps string[]

tags KafkaConnectTag[]

Tags are key-value pairs that allow you to categorize services.

terminationProtection boolean

plan str

project str

service_name str

additional_disk_space str

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloud_name str

disk_space str

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

kafka_connect_user_config KafkaConnectKafkaConnectUserConfigArgs

KafkaConnect user configurable settings

maintenance_window_dow str

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenance_window_time str

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

project_vpc_id str

service_integrations Sequence[KafkaConnectServiceIntegrationArgs]

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

static_ips Sequence[str]

tags Sequence[KafkaConnectTagArgs]

Tags are key-value pairs that allow you to categorize services.

termination_protection bool

plan String

project String

serviceName String

additionalDiskSpace String

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloudName String

diskSpace String

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

kafkaConnectUserConfig Property Map

KafkaConnect user configurable settings

maintenanceWindowDow String

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime String

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

projectVpcId String

serviceIntegrations List<Property Map>

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

staticIps List<String>

tags List<Property Map>

Tags are key-value pairs that allow you to categorize services.

terminationProtection Boolean

Outputs

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

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

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

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

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

components Sequence[KafkaConnectComponent]: Service component information objects
disk_space_cap str: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
disk_space_default str: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
disk_space_step str: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
disk_space_used str: Disk space that service is currently using
id str: The provider-assigned unique ID for this managed resource.
kafka_connects Sequence[KafkaConnectKafkaConnect]: Kafka Connect server provided values
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 or RUNNING

components List<Property Map>: Service component information objects
diskSpaceCap String: The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.
diskSpaceDefault String: The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space
diskSpaceStep String: The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.
diskSpaceUsed String: Disk space that service is currently using
id String: The provider-assigned unique ID for this managed resource.
kafkaConnects List<Property Map>: Kafka Connect server provided values
serviceHost String: The hostname of the service.
servicePassword String: Password used for connecting to the service, if applicable
servicePort Number: The port of the service
serviceType String: Aiven internal service type code
serviceUri String: URI for connecting to the service. Service specific info is under "kafka", "pg", etc.
serviceUsername String: Username used for connecting to the service, if applicable
state String: Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

Look up Existing KafkaConnect Resource

Get an existing KafkaConnect 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?: KafkaConnectState, opts?: CustomResourceOptions): KafkaConnect

@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[KafkaConnectComponentArgs]] = 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_connect_user_config: Optional[KafkaConnectKafkaConnectUserConfigArgs] = None,
        kafka_connects: Optional[Sequence[KafkaConnectKafkaConnectArgs]] = 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[KafkaConnectServiceIntegrationArgs]] = 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[KafkaConnectTagArgs]] = None,
        termination_protection: Optional[bool] = None) -> KafkaConnect

func GetKafkaConnect(ctx *Context, name string, id IDInput, state *KafkaConnectState, opts ...ResourceOption) (*KafkaConnect, error)

public static KafkaConnect Get(string name, Input<string> id, KafkaConnectState? state, CustomResourceOptions? opts = null)

public static KafkaConnect get(String name, Output<String> id, KafkaConnectState 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.

The following state arguments are supported:

AdditionalDiskSpace string

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

CloudName string

Components List<KafkaConnectComponent>

Service component information objects

DiskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

DiskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

DiskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

DiskSpaceStep string

The default disk space step of the service, possible values depend on the service type, the cloud provider and the project. disk_space needs to increment from disk_space_default by increments of this size.

DiskSpaceUsed string

Disk space that service is currently using

KafkaConnectServer List<KafkaConnectKafkaConnect>

Kafka Connect server provided values

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig

KafkaConnect user configurable settings

MaintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

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

Plan string

Project string

ProjectVpcId string

ServiceHost string

The hostname of the service.

ServiceIntegrations List<KafkaConnectServiceIntegration>

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

ServiceName string

ServicePassword string

Password used for connecting to the service, if applicable

ServicePort int

The port of the service

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

ServiceUsername string

Username used for connecting to the service, if applicable

State string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

StaticIps List<string>

Tags List<KafkaConnectTag>

Tags are key-value pairs that allow you to categorize services.

TerminationProtection bool

AdditionalDiskSpace string

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

CloudName string

Components []KafkaConnectComponentArgs

Service component information objects

DiskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

DiskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

DiskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

DiskSpaceStep string

DiskSpaceUsed string

Disk space that service is currently using

KafkaConnectUserConfig KafkaConnectKafkaConnectUserConfigArgs

KafkaConnect user configurable settings

KafkaConnects []KafkaConnectKafkaConnectArgs

Kafka Connect server provided values

MaintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

MaintenanceWindowTime string

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

Plan string

Project string

ProjectVpcId string

ServiceHost string

The hostname of the service.

ServiceIntegrations []KafkaConnectServiceIntegrationArgs

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

ServiceName string

ServicePassword string

Password used for connecting to the service, if applicable

ServicePort int

The port of the service

ServiceType string

Aiven internal service type code

ServiceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

ServiceUsername string

Username used for connecting to the service, if applicable

State string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

StaticIps []string

Tags []KafkaConnectTagArgs

Tags are key-value pairs that allow you to categorize services.

TerminationProtection bool

additionalDiskSpace String

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloudName String

components List<KafkaConnectComponent>

Service component information objects

diskSpace String

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

diskSpaceCap String

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault String

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep String

diskSpaceUsed String

Disk space that service is currently using

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig

KafkaConnect user configurable settings

kafkaConnects List<KafkaConnectKafkaConnect>

Kafka Connect server provided values

maintenanceWindowDow String

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime String

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

plan String

project String

projectVpcId String

serviceHost String

The hostname of the service.

serviceIntegrations List<KafkaConnectServiceIntegration>

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

serviceName String

servicePassword String

Password used for connecting to the service, if applicable

servicePort Integer

The port of the service

serviceType String

Aiven internal service type code

serviceUri String

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername String

Username used for connecting to the service, if applicable

state String

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps List<String>

tags List<KafkaConnectTag>

Tags are key-value pairs that allow you to categorize services.

terminationProtection Boolean

additionalDiskSpace string

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloudName string

components KafkaConnectComponent[]

Service component information objects

diskSpace string

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

diskSpaceCap string

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault string

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep string

diskSpaceUsed string

Disk space that service is currently using

kafkaConnectUserConfig KafkaConnectKafkaConnectUserConfig

KafkaConnect user configurable settings

kafkaConnects KafkaConnectKafkaConnect[]

Kafka Connect server provided values

maintenanceWindowDow string

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime string

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

plan string

project string

projectVpcId string

serviceHost string

The hostname of the service.

serviceIntegrations KafkaConnectServiceIntegration[]

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

serviceName string

servicePassword string

Password used for connecting to the service, if applicable

servicePort number

The port of the service

serviceType string

Aiven internal service type code

serviceUri string

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername string

Username used for connecting to the service, if applicable

state string

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps string[]

tags KafkaConnectTag[]

Tags are key-value pairs that allow you to categorize services.

terminationProtection boolean

additional_disk_space str

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloud_name str

components Sequence[KafkaConnectComponentArgs]

Service component information objects

disk_space str

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

disk_space_cap str

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

disk_space_default str

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

disk_space_step str

disk_space_used str

Disk space that service is currently using

kafka_connect_user_config KafkaConnectKafkaConnectUserConfigArgs

KafkaConnect user configurable settings

kafka_connects Sequence[KafkaConnectKafkaConnectArgs]

Kafka Connect server provided values

maintenance_window_dow str

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenance_window_time str

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

plan str

project str

project_vpc_id str

service_host str

The hostname of the service.

service_integrations Sequence[KafkaConnectServiceIntegrationArgs]

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

service_name str

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 or RUNNING

static_ips Sequence[str]

tags Sequence[KafkaConnectTagArgs]

Tags are key-value pairs that allow you to categorize services.

termination_protection bool

additionalDiskSpace String

Additional disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

cloudName String

components List<Property Map>

Service component information objects

diskSpace String

Service disk space. Possible values depend on the service type, the cloud provider and the project. Therefore, reducing will result in the service rebalancing.

Deprecated:

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

diskSpaceCap String

The maximum disk space of the service, possible values depend on the service type, the cloud provider and the project.

diskSpaceDefault String

The default disk space of the service, possible values depend on the service type, the cloud provider and the project. Its also the minimum value for disk_space

diskSpaceStep String

diskSpaceUsed String

Disk space that service is currently using

kafkaConnectUserConfig Property Map

KafkaConnect user configurable settings

kafkaConnects List<Property Map>

Kafka Connect server provided values

maintenanceWindowDow String

Day of week when maintenance operations should be performed. One monday, tuesday, wednesday, etc.

maintenanceWindowTime String

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

plan String

project String

projectVpcId String

serviceHost String

The hostname of the service.

serviceIntegrations List<Property Map>

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

serviceName String

servicePassword String

Password used for connecting to the service, if applicable

servicePort Number

The port of the service

serviceType String

Aiven internal service type code

serviceUri String

URI for connecting to the service. Service specific info is under "kafka", "pg", etc.

serviceUsername String

Username used for connecting to the service, if applicable

state String

Service state. One of POWEROFF, REBALANCING, REBUILDING or RUNNING

staticIps List<String>

tags List<Property Map>

Tags are key-value pairs that allow you to categorize services.

terminationProtection Boolean

Supporting Types

KafkaConnectComponent, KafkaConnectComponentArgs

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 Integer
route String
ssl Boolean
usage String

component string
host string
kafkaAuthenticationMethod string
port number
route string
ssl boolean
usage string

component str
host str
kafka_authentication_method str
port int
route str
ssl bool
usage str

component String
host String
kafkaAuthenticationMethod String
port Number
route String
ssl Boolean
usage String

KafkaConnectKafkaConnectUserConfig, KafkaConnectKafkaConnectUserConfigArgs

AdditionalBackupRegions string

IpFilterObjects List<KafkaConnectKafkaConnectUserConfigIpFilterObject>

IpFilterStrings List<string>

IpFilters List<string>

Deprecated:

This will be removed in v5.0.0 and replaced with ip_filter_string instead.

KafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect

PrivateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess

PrivatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess

PublicAccess KafkaConnectKafkaConnectUserConfigPublicAccess

StaticIps bool

AdditionalBackupRegions string

IpFilterObjects []KafkaConnectKafkaConnectUserConfigIpFilterObject

IpFilterStrings []string

IpFilters []string

Deprecated:

This will be removed in v5.0.0 and replaced with ip_filter_string instead.

KafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect

PrivateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess

PrivatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess

PublicAccess KafkaConnectKafkaConnectUserConfigPublicAccess

StaticIps bool

additionalBackupRegions String

ipFilterObjects List<KafkaConnectKafkaConnectUserConfigIpFilterObject>

ipFilterStrings List<String>

ipFilters List<String>

Deprecated:

This will be removed in v5.0.0 and replaced with ip_filter_string instead.

kafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect

privateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess

privatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess

publicAccess KafkaConnectKafkaConnectUserConfigPublicAccess

staticIps Boolean

additionalBackupRegions string

ipFilterObjects KafkaConnectKafkaConnectUserConfigIpFilterObject[]

ipFilterStrings string[]

ipFilters string[]

Deprecated:

This will be removed in v5.0.0 and replaced with ip_filter_string instead.

kafkaConnect KafkaConnectKafkaConnectUserConfigKafkaConnect

privateAccess KafkaConnectKafkaConnectUserConfigPrivateAccess

privatelinkAccess KafkaConnectKafkaConnectUserConfigPrivatelinkAccess

publicAccess KafkaConnectKafkaConnectUserConfigPublicAccess

staticIps boolean

additional_backup_regions str

ip_filter_objects Sequence[KafkaConnectKafkaConnectUserConfigIpFilterObject]

ip_filter_strings Sequence[str]

ip_filters Sequence[str]

Deprecated:

This will be removed in v5.0.0 and replaced with ip_filter_string instead.

kafka_connect KafkaConnectKafkaConnectUserConfigKafkaConnect

private_access KafkaConnectKafkaConnectUserConfigPrivateAccess

privatelink_access KafkaConnectKafkaConnectUserConfigPrivatelinkAccess

public_access KafkaConnectKafkaConnectUserConfigPublicAccess

static_ips bool

additionalBackupRegions String

ipFilterObjects List<Property Map>

ipFilterStrings List<String>

ipFilters List<String>

Deprecated:

This will be removed in v5.0.0 and replaced with ip_filter_string instead.

kafkaConnect Property Map

privateAccess Property Map

privatelinkAccess Property Map

publicAccess Property Map

staticIps Boolean

KafkaConnectKafkaConnectUserConfigIpFilterObject, KafkaConnectKafkaConnectUserConfigIpFilterObjectArgs

Network string
Description string

Network string
Description string

network String
description String

network string
description string

network str
description str

network String
description String

KafkaConnectKafkaConnectUserConfigKafkaConnect, KafkaConnectKafkaConnectUserConfigKafkaConnectArgs

ConnectorClientConfigOverridePolicy string
ConsumerAutoOffsetReset string
ConsumerFetchMaxBytes int
ConsumerIsolationLevel string
ConsumerMaxPartitionFetchBytes int
ConsumerMaxPollIntervalMs int
ConsumerMaxPollRecords int
OffsetFlushIntervalMs int
OffsetFlushTimeoutMs int
ProducerBatchSize int
ProducerBufferMemory int
ProducerCompressionType string
ProducerLingerMs int
ProducerMaxRequestSize int
ScheduledRebalanceMaxDelayMs int
SessionTimeoutMs int

ConnectorClientConfigOverridePolicy string
ConsumerAutoOffsetReset string
ConsumerFetchMaxBytes int
ConsumerIsolationLevel string
ConsumerMaxPartitionFetchBytes int
ConsumerMaxPollIntervalMs int
ConsumerMaxPollRecords int
OffsetFlushIntervalMs int
OffsetFlushTimeoutMs int
ProducerBatchSize int
ProducerBufferMemory int
ProducerCompressionType string
ProducerLingerMs int
ProducerMaxRequestSize int
ScheduledRebalanceMaxDelayMs int
SessionTimeoutMs int

connectorClientConfigOverridePolicy String
consumerAutoOffsetReset String
consumerFetchMaxBytes Integer
consumerIsolationLevel String
consumerMaxPartitionFetchBytes Integer
consumerMaxPollIntervalMs Integer
consumerMaxPollRecords Integer
offsetFlushIntervalMs Integer
offsetFlushTimeoutMs Integer
producerBatchSize Integer
producerBufferMemory Integer
producerCompressionType String
producerLingerMs Integer
producerMaxRequestSize Integer
scheduledRebalanceMaxDelayMs Integer
sessionTimeoutMs Integer

connectorClientConfigOverridePolicy string
consumerAutoOffsetReset string
consumerFetchMaxBytes number
consumerIsolationLevel string
consumerMaxPartitionFetchBytes number
consumerMaxPollIntervalMs number
consumerMaxPollRecords number
offsetFlushIntervalMs number
offsetFlushTimeoutMs number
producerBatchSize number
producerBufferMemory number
producerCompressionType string
producerLingerMs number
producerMaxRequestSize number
scheduledRebalanceMaxDelayMs number
sessionTimeoutMs number

connector_client_config_override_policy str
consumer_auto_offset_reset str
consumer_fetch_max_bytes int
consumer_isolation_level str
consumer_max_partition_fetch_bytes int
consumer_max_poll_interval_ms int
consumer_max_poll_records int
offset_flush_interval_ms int
offset_flush_timeout_ms int
producer_batch_size int
producer_buffer_memory int
producer_compression_type str
producer_linger_ms int
producer_max_request_size int
scheduled_rebalance_max_delay_ms int
session_timeout_ms int

connectorClientConfigOverridePolicy String
consumerAutoOffsetReset String
consumerFetchMaxBytes Number
consumerIsolationLevel String
consumerMaxPartitionFetchBytes Number
consumerMaxPollIntervalMs Number
consumerMaxPollRecords Number
offsetFlushIntervalMs Number
offsetFlushTimeoutMs Number
producerBatchSize Number
producerBufferMemory Number
producerCompressionType String
producerLingerMs Number
producerMaxRequestSize Number
scheduledRebalanceMaxDelayMs Number
sessionTimeoutMs Number

KafkaConnectKafkaConnectUserConfigPrivateAccess, KafkaConnectKafkaConnectUserConfigPrivateAccessArgs

KafkaConnect bool
Prometheus bool

KafkaConnect bool
Prometheus bool

kafkaConnect Boolean
prometheus Boolean

kafkaConnect boolean
prometheus boolean

kafka_connect bool
prometheus bool

kafkaConnect Boolean
prometheus Boolean

KafkaConnectKafkaConnectUserConfigPrivatelinkAccess, KafkaConnectKafkaConnectUserConfigPrivatelinkAccessArgs

Jolokia bool
KafkaConnect bool
Prometheus bool

Jolokia bool
KafkaConnect bool
Prometheus bool

jolokia Boolean
kafkaConnect Boolean
prometheus Boolean

jolokia boolean
kafkaConnect boolean
prometheus boolean

jolokia bool
kafka_connect bool
prometheus bool

jolokia Boolean
kafkaConnect Boolean
prometheus Boolean

KafkaConnectKafkaConnectUserConfigPublicAccess, KafkaConnectKafkaConnectUserConfigPublicAccessArgs

KafkaConnect bool
Prometheus bool

KafkaConnect bool
Prometheus bool

kafkaConnect Boolean
prometheus Boolean

kafkaConnect boolean
prometheus boolean

kafka_connect bool
prometheus bool

kafkaConnect Boolean
prometheus Boolean

KafkaConnectServiceIntegration, KafkaConnectServiceIntegrationArgs

IntegrationType string
SourceServiceName string

IntegrationType string
SourceServiceName string

integrationType String
sourceServiceName String

integrationType string
sourceServiceName string

integration_type str
source_service_name str

integrationType String
sourceServiceName String

KafkaConnectTag, KafkaConnectTagArgs

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

Import

 $ pulumi import aiven:index/kafkaConnect:KafkaConnect kc1 project/service_name

Package Details

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

Aiven v6.7.2 published on Tuesday, Oct 31, 2023 by Pulumi

pulumi/pulumi-aiven

aiven.KafkaConnect

On this page

On this page

Example Usage

Create KafkaConnect Resource

KafkaConnect Resource Properties

Inputs

Outputs

Look up Existing KafkaConnect Resource

Supporting Types

KafkaConnectComponent, KafkaConnectComponentArgs

KafkaConnectKafkaConnectUserConfig, KafkaConnectKafkaConnectUserConfigArgs

KafkaConnectKafkaConnectUserConfigIpFilterObject, KafkaConnectKafkaConnectUserConfigIpFilterObjectArgs

KafkaConnectKafkaConnectUserConfigKafkaConnect, KafkaConnectKafkaConnectUserConfigKafkaConnectArgs

KafkaConnectKafkaConnectUserConfigPrivateAccess, KafkaConnectKafkaConnectUserConfigPrivateAccessArgs

KafkaConnectKafkaConnectUserConfigPrivatelinkAccess, KafkaConnectKafkaConnectUserConfigPrivatelinkAccessArgs

KafkaConnectKafkaConnectUserConfigPublicAccess, KafkaConnectKafkaConnectUserConfigPublicAccessArgs

KafkaConnectServiceIntegration, KafkaConnectServiceIntegrationArgs

KafkaConnectTag, KafkaConnectTagArgs

Import

Package Details

On this page

On this page