1. Pulumi Registry
  2. AWS Native
  3. API Docs
  4. kafkaconnect
  5. Connector
aws-native logo
AWS Native v0.55.0, Mar 28 23

aws-native.kafkaconnect.Connector

Resource Type definition for AWS::KafkaConnect::Connector

Create Connector Resource

new Connector(name: string, args: ConnectorArgs, opts?: CustomResourceOptions);
@overload
def Connector(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              capacity: Optional[ConnectorCapacityArgs] = None,
              connector_configuration: Optional[Any] = None,
              connector_description: Optional[str] = None,
              connector_name: Optional[str] = None,
              kafka_cluster: Optional[ConnectorKafkaClusterArgs] = None,
              kafka_cluster_client_authentication: Optional[ConnectorKafkaClusterClientAuthenticationArgs] = None,
              kafka_cluster_encryption_in_transit: Optional[ConnectorKafkaClusterEncryptionInTransitArgs] = None,
              kafka_connect_version: Optional[str] = None,
              log_delivery: Optional[ConnectorLogDeliveryArgs] = None,
              plugins: Optional[Sequence[ConnectorPluginArgs]] = None,
              service_execution_role_arn: Optional[str] = None,
              worker_configuration: Optional[ConnectorWorkerConfigurationArgs] = None)
@overload
def Connector(resource_name: str,
              args: ConnectorArgs,
              opts: Optional[ResourceOptions] = None)
func NewConnector(ctx *Context, name string, args ConnectorArgs, opts ...ResourceOption) (*Connector, error)
public Connector(string name, ConnectorArgs args, CustomResourceOptions? opts = null)
public Connector(String name, ConnectorArgs args)
public Connector(String name, ConnectorArgs args, CustomResourceOptions options)

type: aws-native:kafkaconnect:Connector
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConnectorArgs
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 ConnectorArgs
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 ConnectorArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ConnectorArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Connector 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 Connector resource accepts the following input properties:

Capacity Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorCapacityArgs
ConnectorConfiguration object

The configuration for the connector.

KafkaCluster Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorKafkaClusterArgs
KafkaClusterClientAuthentication Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorKafkaClusterClientAuthenticationArgs
KafkaClusterEncryptionInTransit Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorKafkaClusterEncryptionInTransitArgs
KafkaConnectVersion string

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

Plugins List<Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorPluginArgs>

List of plugins to use with the connector.

ServiceExecutionRoleArn string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

ConnectorDescription string

A summary description of the connector.

ConnectorName string

The name of the connector.

LogDelivery Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorLogDeliveryArgs
WorkerConfiguration Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorWorkerConfigurationArgs
Capacity ConnectorCapacityArgs
ConnectorConfiguration interface{}

The configuration for the connector.

KafkaCluster ConnectorKafkaClusterArgs
KafkaClusterClientAuthentication ConnectorKafkaClusterClientAuthenticationArgs
KafkaClusterEncryptionInTransit ConnectorKafkaClusterEncryptionInTransitArgs
KafkaConnectVersion string

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

Plugins []ConnectorPluginArgs

List of plugins to use with the connector.

ServiceExecutionRoleArn string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

ConnectorDescription string

A summary description of the connector.

ConnectorName string

The name of the connector.

LogDelivery ConnectorLogDeliveryArgs
WorkerConfiguration ConnectorWorkerConfigurationArgs
capacity ConnectorCapacityArgs
connectorConfiguration Object

The configuration for the connector.

kafkaCluster ConnectorKafkaClusterArgs
kafkaClusterClientAuthentication ConnectorKafkaClusterClientAuthenticationArgs
kafkaClusterEncryptionInTransit ConnectorKafkaClusterEncryptionInTransitArgs
kafkaConnectVersion String

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

plugins List<ConnectorPluginArgs>

List of plugins to use with the connector.

serviceExecutionRoleArn String

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

connectorDescription String

A summary description of the connector.

connectorName String

The name of the connector.

logDelivery ConnectorLogDeliveryArgs
workerConfiguration ConnectorWorkerConfigurationArgs
capacity ConnectorCapacityArgs
connectorConfiguration any

The configuration for the connector.

kafkaCluster ConnectorKafkaClusterArgs
kafkaClusterClientAuthentication ConnectorKafkaClusterClientAuthenticationArgs
kafkaClusterEncryptionInTransit ConnectorKafkaClusterEncryptionInTransitArgs
kafkaConnectVersion string

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

plugins ConnectorPluginArgs[]

List of plugins to use with the connector.

serviceExecutionRoleArn string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

connectorDescription string

A summary description of the connector.

connectorName string

The name of the connector.

logDelivery ConnectorLogDeliveryArgs
workerConfiguration ConnectorWorkerConfigurationArgs
capacity ConnectorCapacityArgs
connector_configuration Any

The configuration for the connector.

kafka_cluster ConnectorKafkaClusterArgs
kafka_cluster_client_authentication ConnectorKafkaClusterClientAuthenticationArgs
kafka_cluster_encryption_in_transit ConnectorKafkaClusterEncryptionInTransitArgs
kafka_connect_version str

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

plugins Sequence[ConnectorPluginArgs]

List of plugins to use with the connector.

service_execution_role_arn str

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

connector_description str

A summary description of the connector.

connector_name str

The name of the connector.

log_delivery ConnectorLogDeliveryArgs
worker_configuration ConnectorWorkerConfigurationArgs
capacity Property Map
connectorConfiguration Any

The configuration for the connector.

kafkaCluster Property Map
kafkaClusterClientAuthentication Property Map
kafkaClusterEncryptionInTransit Property Map
kafkaConnectVersion String

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

plugins List<Property Map>

List of plugins to use with the connector.

serviceExecutionRoleArn String

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.

connectorDescription String

A summary description of the connector.

connectorName String

The name of the connector.

logDelivery Property Map
workerConfiguration Property Map

Outputs

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

ConnectorArn string

Amazon Resource Name for the created Connector.

Id string

The provider-assigned unique ID for this managed resource.

ConnectorArn string

Amazon Resource Name for the created Connector.

Id string

The provider-assigned unique ID for this managed resource.

connectorArn String

Amazon Resource Name for the created Connector.

id String

The provider-assigned unique ID for this managed resource.

connectorArn string

Amazon Resource Name for the created Connector.

id string

The provider-assigned unique ID for this managed resource.

connector_arn str

Amazon Resource Name for the created Connector.

id str

The provider-assigned unique ID for this managed resource.

connectorArn String

Amazon Resource Name for the created Connector.

id String

The provider-assigned unique ID for this managed resource.

Supporting Types

ConnectorApacheKafkaCluster

BootstrapServers string

The bootstrap servers string of the Apache Kafka cluster.

Vpc Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorVpc
BootstrapServers string

The bootstrap servers string of the Apache Kafka cluster.

Vpc ConnectorVpc
bootstrapServers String

The bootstrap servers string of the Apache Kafka cluster.

vpc ConnectorVpc
bootstrapServers string

The bootstrap servers string of the Apache Kafka cluster.

vpc ConnectorVpc
bootstrap_servers str

The bootstrap servers string of the Apache Kafka cluster.

vpc ConnectorVpc
bootstrapServers String

The bootstrap servers string of the Apache Kafka cluster.

vpc Property Map

ConnectorAutoScaling

MaxWorkerCount int

The maximum number of workers for a connector.

McuCount int

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

MinWorkerCount int

The minimum number of workers for a connector.

ScaleInPolicy Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorScaleInPolicy
ScaleOutPolicy Pulumi.AwsNative.KafkaConnect.Inputs.ConnectorScaleOutPolicy
MaxWorkerCount int

The maximum number of workers for a connector.

McuCount int

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

MinWorkerCount int

The minimum number of workers for a connector.

ScaleInPolicy ConnectorScaleInPolicy
ScaleOutPolicy ConnectorScaleOutPolicy
maxWorkerCount Integer

The maximum number of workers for a connector.

mcuCount Integer

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

minWorkerCount Integer

The minimum number of workers for a connector.

scaleInPolicy ConnectorScaleInPolicy
scaleOutPolicy ConnectorScaleOutPolicy
maxWorkerCount number

The maximum number of workers for a connector.

mcuCount number

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

minWorkerCount number

The minimum number of workers for a connector.

scaleInPolicy ConnectorScaleInPolicy
scaleOutPolicy ConnectorScaleOutPolicy
max_worker_count int

The maximum number of workers for a connector.

mcu_count int

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

min_worker_count int

The minimum number of workers for a connector.

scale_in_policy ConnectorScaleInPolicy
scale_out_policy ConnectorScaleOutPolicy
maxWorkerCount Number

The maximum number of workers for a connector.

mcuCount Number

Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.

minWorkerCount Number

The minimum number of workers for a connector.

scaleInPolicy Property Map
scaleOutPolicy Property Map

ConnectorCapacity

ConnectorCloudWatchLogsLogDelivery

Enabled bool

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

LogGroup string

The CloudWatch log group that is the destination for log delivery.

Enabled bool

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

LogGroup string

The CloudWatch log group that is the destination for log delivery.

enabled Boolean

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

logGroup String

The CloudWatch log group that is the destination for log delivery.

enabled boolean

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

logGroup string

The CloudWatch log group that is the destination for log delivery.

enabled bool

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

log_group str

The CloudWatch log group that is the destination for log delivery.

enabled Boolean

Specifies whether the logs get sent to the specified CloudWatch Logs destination.

logGroup String

The CloudWatch log group that is the destination for log delivery.

ConnectorCustomPlugin

CustomPluginArn string

The Amazon Resource Name (ARN) of the custom plugin to use.

Revision int

The revision of the custom plugin to use.

CustomPluginArn string

The Amazon Resource Name (ARN) of the custom plugin to use.

Revision int

The revision of the custom plugin to use.

customPluginArn String

The Amazon Resource Name (ARN) of the custom plugin to use.

revision Integer

The revision of the custom plugin to use.

customPluginArn string

The Amazon Resource Name (ARN) of the custom plugin to use.

revision number

The revision of the custom plugin to use.

custom_plugin_arn str

The Amazon Resource Name (ARN) of the custom plugin to use.

revision int

The revision of the custom plugin to use.

customPluginArn String

The Amazon Resource Name (ARN) of the custom plugin to use.

revision Number

The revision of the custom plugin to use.

ConnectorFirehoseLogDelivery

Enabled bool

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

DeliveryStream string

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

Enabled bool

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

DeliveryStream string

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

enabled Boolean

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

deliveryStream String

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

enabled boolean

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

deliveryStream string

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

enabled bool

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

delivery_stream str

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

enabled Boolean

Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.

deliveryStream String

The Kinesis Data Firehose delivery stream that is the destination for log delivery.

ConnectorKafkaCluster

ConnectorKafkaClusterClientAuthentication

ConnectorKafkaClusterClientAuthenticationType

None
NONE
Iam
IAM
ConnectorKafkaClusterClientAuthenticationTypeNone
NONE
ConnectorKafkaClusterClientAuthenticationTypeIam
IAM
None
NONE
Iam
IAM
None
NONE
Iam
IAM
NONE
NONE
IAM
IAM
"NONE"
NONE
"IAM"
IAM

ConnectorKafkaClusterEncryptionInTransit

ConnectorKafkaClusterEncryptionInTransitType

Plaintext
PLAINTEXT
Tls
TLS
ConnectorKafkaClusterEncryptionInTransitTypePlaintext
PLAINTEXT
ConnectorKafkaClusterEncryptionInTransitTypeTls
TLS
Plaintext
PLAINTEXT
Tls
TLS
Plaintext
PLAINTEXT
Tls
TLS
PLAINTEXT
PLAINTEXT
TLS
TLS
"PLAINTEXT"
PLAINTEXT
"TLS"
TLS

ConnectorLogDelivery

ConnectorPlugin

ConnectorProvisionedCapacity

WorkerCount int

Number of workers for a connector.

McuCount int

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

WorkerCount int

Number of workers for a connector.

McuCount int

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

workerCount Integer

Number of workers for a connector.

mcuCount Integer

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

workerCount number

Number of workers for a connector.

mcuCount number

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

worker_count int

Number of workers for a connector.

mcu_count int

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

workerCount Number

Number of workers for a connector.

mcuCount Number

Specifies how many MSK Connect Units (MCU) are allocated to the connector.

ConnectorS3LogDelivery

Enabled bool

Specifies whether the logs get sent to the specified Amazon S3 destination.

Bucket string

The name of the S3 bucket that is the destination for log delivery.

Prefix string

The S3 prefix that is the destination for log delivery.

Enabled bool

Specifies whether the logs get sent to the specified Amazon S3 destination.

Bucket string

The name of the S3 bucket that is the destination for log delivery.

Prefix string

The S3 prefix that is the destination for log delivery.

enabled Boolean

Specifies whether the logs get sent to the specified Amazon S3 destination.

bucket String

The name of the S3 bucket that is the destination for log delivery.

prefix String

The S3 prefix that is the destination for log delivery.

enabled boolean

Specifies whether the logs get sent to the specified Amazon S3 destination.

bucket string

The name of the S3 bucket that is the destination for log delivery.

prefix string

The S3 prefix that is the destination for log delivery.

enabled bool

Specifies whether the logs get sent to the specified Amazon S3 destination.

bucket str

The name of the S3 bucket that is the destination for log delivery.

prefix str

The S3 prefix that is the destination for log delivery.

enabled Boolean

Specifies whether the logs get sent to the specified Amazon S3 destination.

bucket String

The name of the S3 bucket that is the destination for log delivery.

prefix String

The S3 prefix that is the destination for log delivery.

ConnectorScaleInPolicy

CpuUtilizationPercentage int

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

CpuUtilizationPercentage int

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

cpuUtilizationPercentage Integer

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

cpuUtilizationPercentage number

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

cpu_utilization_percentage int

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

cpuUtilizationPercentage Number

Specifies the CPU utilization percentage threshold at which connector scale in should trigger.

ConnectorScaleOutPolicy

CpuUtilizationPercentage int

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

CpuUtilizationPercentage int

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

cpuUtilizationPercentage Integer

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

cpuUtilizationPercentage number

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

cpu_utilization_percentage int

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

cpuUtilizationPercentage Number

Specifies the CPU utilization percentage threshold at which connector scale out should trigger.

ConnectorVpc

SecurityGroups List<string>

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

Subnets List<string>

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

SecurityGroups []string

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

Subnets []string

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

securityGroups List<String>

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

subnets List<String>

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

securityGroups string[]

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

subnets string[]

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

security_groups Sequence[str]

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

subnets Sequence[str]

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

securityGroups List<String>

The AWS security groups to associate with the elastic network interfaces in order to specify what the connector has access to.

subnets List<String>

The list of subnets to connect to in the virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets.

ConnectorWorkerConfiguration

Revision int

The revision of the worker configuration to use.

WorkerConfigurationArn string

The Amazon Resource Name (ARN) of the worker configuration to use.

Revision int

The revision of the worker configuration to use.

WorkerConfigurationArn string

The Amazon Resource Name (ARN) of the worker configuration to use.

revision Integer

The revision of the worker configuration to use.

workerConfigurationArn String

The Amazon Resource Name (ARN) of the worker configuration to use.

revision number

The revision of the worker configuration to use.

workerConfigurationArn string

The Amazon Resource Name (ARN) of the worker configuration to use.

revision int

The revision of the worker configuration to use.

worker_configuration_arn str

The Amazon Resource Name (ARN) of the worker configuration to use.

revision Number

The revision of the worker configuration to use.

workerConfigurationArn String

The Amazon Resource Name (ARN) of the worker configuration to use.

ConnectorWorkerLogDelivery

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0