pulumi-aws-kotlin/com.pulumi.aws.mskconnect.kotlin/ConnectorArgs

ConnectorArgs

data class ConnectorArgs(val capacity: Output<ConnectorCapacityArgs>? = null, val connectorConfiguration: Output<Map<String, String>>? = null, val description: Output<String>? = null, val kafkaCluster: Output<ConnectorKafkaClusterArgs>? = null, val kafkaClusterClientAuthentication: Output<ConnectorKafkaClusterClientAuthenticationArgs>? = null, val kafkaClusterEncryptionInTransit: Output<ConnectorKafkaClusterEncryptionInTransitArgs>? = null, val kafkaconnectVersion: Output<String>? = null, val logDelivery: Output<ConnectorLogDeliveryArgs>? = null, val name: Output<String>? = null, val plugins: Output<List<ConnectorPluginArgs>>? = null, val serviceExecutionRoleArn: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val workerConfiguration: Output<ConnectorWorkerConfigurationArgs>? = null) : ConvertibleToJava<ConnectorArgs>

Provides an Amazon MSK Connect Connector resource.

Example Usage

Basic configuration

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.mskconnect.Connector("example", {
    name: "example",
    kafkaconnectVersion: "2.7.1",
    capacity: {
        autoscaling: {
            mcuCount: 1,
            minWorkerCount: 1,
            maxWorkerCount: 2,
            scaleInPolicy: {
                cpuUtilizationPercentage: 20,
            },
            scaleOutPolicy: {
                cpuUtilizationPercentage: 80,
            },
        },
    },
    connectorConfiguration: {
        "connector.class": "com.github.jcustenborder.kafka.connect.simulator.SimulatorSinkConnector",
        "tasks.max": "1",
        topics: "example",
    },
    kafkaCluster: {
        apacheKafkaCluster: {
            bootstrapServers: exampleAwsMskCluster.bootstrapBrokersTls,
            vpc: {
                securityGroups: [exampleAwsSecurityGroup&#46;id],
                subnets: [
                    example1.id,
                    example2.id,
                    example3.id,
                ],
            },
        },
    },
    kafkaClusterClientAuthentication: {
        authenticationType: "NONE",
    },
    kafkaClusterEncryptionInTransit: {
        encryptionType: "TLS",
    },
    plugins: [{
        customPlugin: {
            arn: exampleAwsMskconnectCustomPlugin.arn,
            revision: exampleAwsMskconnectCustomPlugin.latestRevision,
        },
    }],
    serviceExecutionRoleArn: exampleAwsIamRole.arn,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
example = aws.mskconnect.Connector("example",
    name="example",
    kafkaconnect_version="2.7.1",
    capacity={
        "autoscaling": {
            "mcu_count": 1,
            "min_worker_count": 1,
            "max_worker_count": 2,
            "scale_in_policy": {
                "cpu_utilization_percentage": 20,
            },
            "scale_out_policy": {
                "cpu_utilization_percentage": 80,
            },
        },
    },
    connector_configuration={
        "connector.class": "com.github.jcustenborder.kafka.connect.simulator.SimulatorSinkConnector",
        "tasks.max": "1",
        "topics": "example",
    },
    kafka_cluster={
        "apache_kafka_cluster": {
            "bootstrap_servers": example_aws_msk_cluster["bootstrapBrokersTls"],
            "vpc": {
                "security_groups": [example_aws_security_group["id"]],
                "subnets": [
                    example1["id"],
                    example2["id"],
                    example3["id"],
                ],
            },
        },
    },
    kafka_cluster_client_authentication={
        "authentication_type": "NONE",
    },
    kafka_cluster_encryption_in_transit={
        "encryption_type": "TLS",
    },
    plugins=[{
        "custom_plugin": {
            "arn": example_aws_mskconnect_custom_plugin["arn"],
            "revision": example_aws_mskconnect_custom_plugin["latestRevision"],
        },
    }],
    service_execution_role_arn=example_aws_iam_role["arn"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var example = new Aws.MskConnect.Connector("example", new()
    {
        Name = "example",
        KafkaconnectVersion = "2.7.1",
        Capacity = new Aws.MskConnect.Inputs.ConnectorCapacityArgs
        {
            Autoscaling = new Aws.MskConnect.Inputs.ConnectorCapacityAutoscalingArgs
            {
                McuCount = 1,
                MinWorkerCount = 1,
                MaxWorkerCount = 2,
                ScaleInPolicy = new Aws.MskConnect.Inputs.ConnectorCapacityAutoscalingScaleInPolicyArgs
                {
                    CpuUtilizationPercentage = 20,
                },
                ScaleOutPolicy = new Aws.MskConnect.Inputs.ConnectorCapacityAutoscalingScaleOutPolicyArgs
                {
                    CpuUtilizationPercentage = 80,
                },
            },
        },
        ConnectorConfiguration =
        {
            { "connector.class", "com.github.jcustenborder.kafka.connect.simulator.SimulatorSinkConnector" },
            { "tasks.max", "1" },
            { "topics", "example" },
        },
        KafkaCluster = new Aws.MskConnect.Inputs.ConnectorKafkaClusterArgs
        {
            ApacheKafkaCluster = new Aws.MskConnect.Inputs.ConnectorKafkaClusterApacheKafkaClusterArgs
            {
                BootstrapServers = exampleAwsMskCluster.BootstrapBrokersTls,
                Vpc = new Aws.MskConnect.Inputs.ConnectorKafkaClusterApacheKafkaClusterVpcArgs
                {
                    SecurityGroups = new[]
                    {
                        exampleAwsSecurityGroup.Id,
                    },
                    Subnets = new[]
                    {
                        example1.Id,
                        example2.Id,
                        example3.Id,
                    },
                },
            },
        },
        KafkaClusterClientAuthentication = new Aws.MskConnect.Inputs.ConnectorKafkaClusterClientAuthenticationArgs
        {
            AuthenticationType = "NONE",
        },
        KafkaClusterEncryptionInTransit = new Aws.MskConnect.Inputs.ConnectorKafkaClusterEncryptionInTransitArgs
        {
            EncryptionType = "TLS",
        },
        Plugins = new[]
        {
            new Aws.MskConnect.Inputs.ConnectorPluginArgs
            {
                CustomPlugin = new Aws.MskConnect.Inputs.ConnectorPluginCustomPluginArgs
                {
                    Arn = exampleAwsMskconnectCustomPlugin.Arn,
                    Revision = exampleAwsMskconnectCustomPlugin.LatestRevision,
                },
            },
        },
        ServiceExecutionRoleArn = exampleAwsIamRole.Arn,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/mskconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mskconnect.NewConnector(ctx, "example", &mskconnect.ConnectorArgs{
			Name:                pulumi.String("example"),
			KafkaconnectVersion: pulumi.String("2.7.1"),
			Capacity: &mskconnect.ConnectorCapacityArgs{
				Autoscaling: &mskconnect.ConnectorCapacityAutoscalingArgs{
					McuCount:       pulumi.Int(1),
					MinWorkerCount: pulumi.Int(1),
					MaxWorkerCount: pulumi.Int(2),
					ScaleInPolicy: &mskconnect.ConnectorCapacityAutoscalingScaleInPolicyArgs{
						CpuUtilizationPercentage: pulumi.Int(20),
					},
					ScaleOutPolicy: &mskconnect.ConnectorCapacityAutoscalingScaleOutPolicyArgs{
						CpuUtilizationPercentage: pulumi.Int(80),
					},
				},
			},
			ConnectorConfiguration: pulumi.StringMap{
				"connector.class": pulumi.String("com.github.jcustenborder.kafka.connect.simulator.SimulatorSinkConnector"),
				"tasks.max":       pulumi.String("1"),
				"topics":          pulumi.String("example"),
			},
			KafkaCluster: &mskconnect.ConnectorKafkaClusterArgs{
				ApacheKafkaCluster: &mskconnect.ConnectorKafkaClusterApacheKafkaClusterArgs{
					BootstrapServers: pulumi.Any(exampleAwsMskCluster.BootstrapBrokersTls),
					Vpc: &mskconnect.ConnectorKafkaClusterApacheKafkaClusterVpcArgs{
						SecurityGroups: pulumi.StringArray{
							exampleAwsSecurityGroup.Id,
						},
						Subnets: pulumi.StringArray{
							example1.Id,
							example2.Id,
							example3.Id,
						},
					},
				},
			},
			KafkaClusterClientAuthentication: &mskconnect.ConnectorKafkaClusterClientAuthenticationArgs{
				AuthenticationType: pulumi.String("NONE"),
			},
			KafkaClusterEncryptionInTransit: &mskconnect.ConnectorKafkaClusterEncryptionInTransitArgs{
				EncryptionType: pulumi.String("TLS"),
			},
			Plugins: mskconnect.ConnectorPluginArray{
				&mskconnect.ConnectorPluginArgs{
					CustomPlugin: &mskconnect.ConnectorPluginCustomPluginArgs{
						Arn:      pulumi.Any(exampleAwsMskconnectCustomPlugin.Arn),
						Revision: pulumi.Any(exampleAwsMskconnectCustomPlugin.LatestRevision),
					},
				},
			},
			ServiceExecutionRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.mskconnect.Connector;
import com.pulumi.aws.mskconnect.ConnectorArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorCapacityArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorCapacityAutoscalingArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorCapacityAutoscalingScaleInPolicyArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorCapacityAutoscalingScaleOutPolicyArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorKafkaClusterArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorKafkaClusterApacheKafkaClusterArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorKafkaClusterApacheKafkaClusterVpcArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorKafkaClusterClientAuthenticationArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorKafkaClusterEncryptionInTransitArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorPluginArgs;
import com.pulumi.aws.mskconnect.inputs.ConnectorPluginCustomPluginArgs;
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 example = new Connector("example", ConnectorArgs.builder()
            .name("example")
            .kafkaconnectVersion("2.7.1")
            .capacity(ConnectorCapacityArgs.builder()
                .autoscaling(ConnectorCapacityAutoscalingArgs.builder()
                    .mcuCount(1)
                    .minWorkerCount(1)
                    .maxWorkerCount(2)
                    .scaleInPolicy(ConnectorCapacityAutoscalingScaleInPolicyArgs.builder()
                        .cpuUtilizationPercentage(20)
                        .build())
                    .scaleOutPolicy(ConnectorCapacityAutoscalingScaleOutPolicyArgs.builder()
                        .cpuUtilizationPercentage(80)
                        .build())
                    .build())
                .build())
            .connectorConfiguration(Map.ofEntries(
                Map.entry("connector.class", "com.github.jcustenborder.kafka.connect.simulator.SimulatorSinkConnector"),
                Map.entry("tasks.max", "1"),
                Map.entry("topics", "example")
            ))
            .kafkaCluster(ConnectorKafkaClusterArgs.builder()
                .apacheKafkaCluster(ConnectorKafkaClusterApacheKafkaClusterArgs.builder()
                    .bootstrapServers(exampleAwsMskCluster.bootstrapBrokersTls())
                    .vpc(ConnectorKafkaClusterApacheKafkaClusterVpcArgs.builder()
                        .securityGroups(exampleAwsSecurityGroup.id())
                        .subnets(
                            example1.id(),
                            example2.id(),
                            example3.id())
                        .build())
                    .build())
                .build())
            .kafkaClusterClientAuthentication(ConnectorKafkaClusterClientAuthenticationArgs.builder()
                .authenticationType("NONE")
                .build())
            .kafkaClusterEncryptionInTransit(ConnectorKafkaClusterEncryptionInTransitArgs.builder()
                .encryptionType("TLS")
                .build())
            .plugins(ConnectorPluginArgs.builder()
                .customPlugin(ConnectorPluginCustomPluginArgs.builder()
                    .arn(exampleAwsMskconnectCustomPlugin.arn())
                    .revision(exampleAwsMskconnectCustomPlugin.latestRevision())
                    .build())
                .build())
            .serviceExecutionRoleArn(exampleAwsIamRole.arn())
            .build());
    }
}
Content copied to clipboard
resources:
  example:
    type: aws:mskconnect:Connector
    properties:
      name: example
      kafkaconnectVersion: 2.7.1
      capacity:
        autoscaling:
          mcuCount: 1
          minWorkerCount: 1
          maxWorkerCount: 2
          scaleInPolicy:
            cpuUtilizationPercentage: 20
          scaleOutPolicy:
            cpuUtilizationPercentage: 80
      connectorConfiguration:
        connector.class: com.github.jcustenborder.kafka.connect.simulator.SimulatorSinkConnector
        tasks.max: '1'
        topics: example
      kafkaCluster:
        apacheKafkaCluster:
          bootstrapServers: ${exampleAwsMskCluster.bootstrapBrokersTls}
          vpc:
            securityGroups:
              - ${exampleAwsSecurityGroup.id}
            subnets:
              - ${example1.id}
              - ${example2.id}
              - ${example3.id}
      kafkaClusterClientAuthentication:
        authenticationType: NONE
      kafkaClusterEncryptionInTransit:
        encryptionType: TLS
      plugins:
        - customPlugin:
            arn: ${exampleAwsMskconnectCustomPlugin.arn}
            revision: ${exampleAwsMskconnectCustomPlugin.latestRevision}
      serviceExecutionRoleArn: ${exampleAwsIamRole.arn}
Content copied to clipboard

Import

Using pulumi import, import MSK Connect Connector using the connector's arn. For example:

$ pulumi import aws:mskconnect/connector:Connector example 'arn:aws:kafkaconnect:eu-central-1:123456789012:connector/example/264edee4-17a3-412e-bd76-6681cfc93805-3'
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(capacity: Output<ConnectorCapacityArgs>? = null, connectorConfiguration: Output<Map<String, String>>? = null, description: Output<String>? = null, kafkaCluster: Output<ConnectorKafkaClusterArgs>? = null, kafkaClusterClientAuthentication: Output<ConnectorKafkaClusterClientAuthenticationArgs>? = null, kafkaClusterEncryptionInTransit: Output<ConnectorKafkaClusterEncryptionInTransitArgs>? = null, kafkaconnectVersion: Output<String>? = null, logDelivery: Output<ConnectorLogDeliveryArgs>? = null, name: Output<String>? = null, plugins: Output<List<ConnectorPluginArgs>>? = null, serviceExecutionRoleArn: Output<String>? = null, tags: Output<Map<String, String>>? = null, workerConfiguration: Output<ConnectorWorkerConfigurationArgs>? = null)

Properties

Link copied to clipboard
val capacity: Output<ConnectorCapacityArgs>? = null

Information about the capacity allocated to the connector. See capacity Block for details.

Link copied to clipboard
val connectorConfiguration: Output<Map<String, String>>? = null

A map of keys to values that represent the configuration for the connector.

Link copied to clipboard
val description: Output<String>? = null

A summary description of the connector.

Link copied to clipboard
val kafkaCluster: Output<ConnectorKafkaClusterArgs>? = null

Specifies which Apache Kafka cluster to connect to. See kafka_cluster Block for details.

Link copied to clipboard
val kafkaClusterClientAuthentication: Output<ConnectorKafkaClusterClientAuthenticationArgs>? = null

Details of the client authentication used by the Apache Kafka cluster. See kafka_cluster_client_authentication Block for details.

Link copied to clipboard
val kafkaClusterEncryptionInTransit: Output<ConnectorKafkaClusterEncryptionInTransitArgs>? = null

Details of encryption in transit to the Apache Kafka cluster. See kafka_cluster_encryption_in_transit Block for details.

Link copied to clipboard
val kafkaconnectVersion: Output<String>? = null

The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.

Link copied to clipboard
val logDelivery: Output<ConnectorLogDeliveryArgs>? = null

Details about log delivery. See log_delivery Block for details.

Link copied to clipboard
val name: Output<String>? = null

The name of the connector.

Link copied to clipboard
val plugins: Output<List<ConnectorPluginArgs>>? = null

Specifies which plugins to use for the connector. See plugin Block for details.

Link copied to clipboard
val serviceExecutionRoleArn: Output<String>? = null

The Amazon Resource Name (ARN) of the IAM role used by the connector to access the Amazon Web Services resources that it needs. The types of resources depends on the logic of the connector. For example, a connector that has Amazon S3 as a destination must have permissions that allow it to write to the S3 destination bucket. The following arguments are optional:

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val workerConfiguration: Output<ConnectorWorkerConfigurationArgs>? = null

Specifies which worker configuration to use with the connector. See worker_configuration Block for details.

Functions

Link copied to clipboard
open override fun toJava(): ConnectorArgs