AWS Native is in preview. AWS Classic is fully supported.
aws-native.kafkaconnect.Connector
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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.
Aws Native. Kafka Connect. Inputs. Connector Capacity - Connector
Configuration object The configuration for the connector.
- Kafka
Cluster Pulumi.Aws Native. Kafka Connect. Inputs. Connector Kafka Cluster - Kafka
Cluster Pulumi.Client Authentication Aws Native. Kafka Connect. Inputs. Connector Kafka Cluster Client Authentication - Kafka
Cluster Pulumi.Encryption In Transit Aws Native. Kafka Connect. Inputs. Connector Kafka Cluster Encryption In Transit - Kafka
Connect stringVersion The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
- Plugins
List<Pulumi.
Aws Native. Kafka Connect. Inputs. Connector Plugin> List of plugins to use with the connector.
- Service
Execution stringRole Arn The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
- Connector
Description string A summary description of the connector.
- Connector
Name string The name of the connector.
- Log
Delivery Pulumi.Aws Native. Kafka Connect. Inputs. Connector Log Delivery - Worker
Configuration Pulumi.Aws Native. Kafka Connect. Inputs. Connector Worker Configuration
- Capacity
Connector
Capacity Args - Connector
Configuration interface{} The configuration for the connector.
- Kafka
Cluster ConnectorKafka Cluster Args - Kafka
Cluster ConnectorClient Authentication Kafka Cluster Client Authentication Args - Kafka
Cluster ConnectorEncryption In Transit Kafka Cluster Encryption In Transit Args - Kafka
Connect stringVersion The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
- Plugins
[]Connector
Plugin Args List of plugins to use with the connector.
- Service
Execution stringRole Arn The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
- Connector
Description string A summary description of the connector.
- Connector
Name string The name of the connector.
- Log
Delivery ConnectorLog Delivery Args - Worker
Configuration ConnectorWorker Configuration Args
- capacity
Connector
Capacity - connector
Configuration Object The configuration for the connector.
- kafka
Cluster ConnectorKafka Cluster - kafka
Cluster ConnectorClient Authentication Kafka Cluster Client Authentication - kafka
Cluster ConnectorEncryption In Transit Kafka Cluster Encryption In Transit - kafka
Connect StringVersion The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
- plugins
List<Connector
Plugin> List of plugins to use with the connector.
- service
Execution StringRole Arn The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
- connector
Description String A summary description of the connector.
- connector
Name String The name of the connector.
- log
Delivery ConnectorLog Delivery - worker
Configuration ConnectorWorker Configuration
- capacity
Connector
Capacity - connector
Configuration any The configuration for the connector.
- kafka
Cluster ConnectorKafka Cluster - kafka
Cluster ConnectorClient Authentication Kafka Cluster Client Authentication - kafka
Cluster ConnectorEncryption In Transit Kafka Cluster Encryption In Transit - kafka
Connect stringVersion The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
- plugins
Connector
Plugin[] List of plugins to use with the connector.
- service
Execution stringRole Arn The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
- connector
Description string A summary description of the connector.
- connector
Name string The name of the connector.
- log
Delivery ConnectorLog Delivery - worker
Configuration ConnectorWorker Configuration
- capacity
Connector
Capacity Args - connector_
configuration Any The configuration for the connector.
- kafka_
cluster ConnectorKafka Cluster Args - kafka_
cluster_ Connectorclient_ authentication Kafka Cluster Client Authentication Args - kafka_
cluster_ Connectorencryption_ in_ transit Kafka Cluster Encryption In Transit Args - kafka_
connect_ strversion The version of Kafka Connect. It has to be compatible with both the Kafka cluster's version and the plugins.
- plugins
Sequence[Connector
Plugin Args] List of plugins to use with the connector.
- service_
execution_ strrole_ arn 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 ConnectorLog Delivery Args - worker_
configuration ConnectorWorker Configuration Args
- capacity Property Map
- connector
Configuration Any The configuration for the connector.
- kafka
Cluster Property Map - kafka
Cluster Property MapClient Authentication - kafka
Cluster Property MapEncryption In Transit - kafka
Connect StringVersion 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.
- service
Execution StringRole Arn The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon S3 objects and other external resources.
- connector
Description String A summary description of the connector.
- connector
Name String The name of the connector.
- log
Delivery Property Map - worker
Configuration Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the Connector resource produces the following output properties:
- Connector
Arn string Amazon Resource Name for the created Connector.
- Id string
The provider-assigned unique ID for this managed resource.
- Connector
Arn string Amazon Resource Name for the created Connector.
- Id string
The provider-assigned unique ID for this managed resource.
- connector
Arn String Amazon Resource Name for the created Connector.
- id String
The provider-assigned unique ID for this managed resource.
- connector
Arn 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.
- connector
Arn String Amazon Resource Name for the created Connector.
- id String
The provider-assigned unique ID for this managed resource.
Supporting Types
ConnectorApacheKafkaCluster, ConnectorApacheKafkaClusterArgs
- Bootstrap
Servers string The bootstrap servers string of the Apache Kafka cluster.
- Vpc
Pulumi.
Aws Native. Kafka Connect. Inputs. Connector Vpc
- Bootstrap
Servers string The bootstrap servers string of the Apache Kafka cluster.
- Vpc
Connector
Vpc
- bootstrap
Servers String The bootstrap servers string of the Apache Kafka cluster.
- vpc
Connector
Vpc
- bootstrap
Servers string The bootstrap servers string of the Apache Kafka cluster.
- vpc
Connector
Vpc
- bootstrap_
servers str The bootstrap servers string of the Apache Kafka cluster.
- vpc
Connector
Vpc
- bootstrap
Servers String The bootstrap servers string of the Apache Kafka cluster.
- vpc Property Map
ConnectorAutoScaling, ConnectorAutoScalingArgs
- Max
Worker intCount 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 intCount The minimum number of workers for a connector.
- Scale
In Pulumi.Policy Aws Native. Kafka Connect. Inputs. Connector Scale In Policy - Scale
Out Pulumi.Policy Aws Native. Kafka Connect. Inputs. Connector Scale Out Policy
- Max
Worker intCount 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 intCount The minimum number of workers for a connector.
- Scale
In ConnectorPolicy Scale In Policy - Scale
Out ConnectorPolicy Scale Out Policy
- max
Worker IntegerCount The maximum number of workers for a connector.
- mcu
Count Integer Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.
- min
Worker IntegerCount The minimum number of workers for a connector.
- scale
In ConnectorPolicy Scale In Policy - scale
Out ConnectorPolicy Scale Out Policy
- max
Worker numberCount The maximum number of workers for a connector.
- mcu
Count number Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.
- min
Worker numberCount The minimum number of workers for a connector.
- scale
In ConnectorPolicy Scale In Policy - scale
Out ConnectorPolicy Scale Out Policy
- max_
worker_ intcount 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_ intcount The minimum number of workers for a connector.
- scale_
in_ Connectorpolicy Scale In Policy - scale_
out_ Connectorpolicy Scale Out Policy
- max
Worker NumberCount The maximum number of workers for a connector.
- mcu
Count Number Specifies how many MSK Connect Units (MCU) as the minimum scaling unit.
- min
Worker NumberCount The minimum number of workers for a connector.
- scale
In Property MapPolicy - scale
Out Property MapPolicy
ConnectorCapacity, ConnectorCapacityArgs
ConnectorCloudWatchLogsLogDelivery, ConnectorCloudWatchLogsLogDeliveryArgs
ConnectorCustomPlugin, ConnectorCustomPluginArgs
- Custom
Plugin stringArn The Amazon Resource Name (ARN) of the custom plugin to use.
- Revision int
The revision of the custom plugin to use.
- Custom
Plugin stringArn The Amazon Resource Name (ARN) of the custom plugin to use.
- Revision int
The revision of the custom plugin to use.
- custom
Plugin StringArn The Amazon Resource Name (ARN) of the custom plugin to use.
- revision Integer
The revision of the custom plugin to use.
- custom
Plugin stringArn The Amazon Resource Name (ARN) of the custom plugin to use.
- revision number
The revision of the custom plugin to use.
- custom_
plugin_ strarn The Amazon Resource Name (ARN) of the custom plugin to use.
- revision int
The revision of the custom plugin to use.
- custom
Plugin StringArn The Amazon Resource Name (ARN) of the custom plugin to use.
- revision Number
The revision of the custom plugin to use.
ConnectorFirehoseLogDelivery, ConnectorFirehoseLogDeliveryArgs
- Enabled bool
Specifies whether the logs get sent to the specified Kinesis Data Firehose delivery stream.
- Delivery
Stream 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 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.
- delivery
Stream 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.
- delivery
Stream 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.
- delivery
Stream String The Kinesis Data Firehose delivery stream that is the destination for log delivery.
ConnectorKafkaCluster, ConnectorKafkaClusterArgs
ConnectorKafkaClusterClientAuthentication, ConnectorKafkaClusterClientAuthenticationArgs
ConnectorKafkaClusterClientAuthenticationType, ConnectorKafkaClusterClientAuthenticationTypeArgs
- None
- NONE
- Iam
- IAM
- Connector
Kafka Cluster Client Authentication Type None - NONE
- Connector
Kafka Cluster Client Authentication Type Iam - IAM
- None
- NONE
- Iam
- IAM
- None
- NONE
- Iam
- IAM
- NONE
- NONE
- IAM
- IAM
- "NONE"
- NONE
- "IAM"
- IAM
ConnectorKafkaClusterEncryptionInTransit, ConnectorKafkaClusterEncryptionInTransitArgs
ConnectorKafkaClusterEncryptionInTransitType, ConnectorKafkaClusterEncryptionInTransitTypeArgs
- Plaintext
- PLAINTEXT
- Tls
- TLS
- Connector
Kafka Cluster Encryption In Transit Type Plaintext - PLAINTEXT
- Connector
Kafka Cluster Encryption In Transit Type Tls - TLS
- Plaintext
- PLAINTEXT
- Tls
- TLS
- Plaintext
- PLAINTEXT
- Tls
- TLS
- PLAINTEXT
- PLAINTEXT
- TLS
- TLS
- "PLAINTEXT"
- PLAINTEXT
- "TLS"
- TLS
ConnectorLogDelivery, ConnectorLogDeliveryArgs
ConnectorPlugin, ConnectorPluginArgs
ConnectorProvisionedCapacity, ConnectorProvisionedCapacityArgs
- Worker
Count int Number of workers for a connector.
- Mcu
Count int 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.
- worker
Count Integer Number of workers for a connector.
- mcu
Count Integer Specifies how many MSK Connect Units (MCU) are allocated to the connector.
- worker
Count number Number of workers for a connector.
- mcu
Count 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.
- worker
Count Number Number of workers for a connector.
- mcu
Count Number Specifies how many MSK Connect Units (MCU) are allocated to the connector.
ConnectorS3LogDelivery, ConnectorS3LogDeliveryArgs
ConnectorScaleInPolicy, ConnectorScaleInPolicyArgs
- Cpu
Utilization intPercentage Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
- Cpu
Utilization intPercentage Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
- cpu
Utilization IntegerPercentage Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
- cpu
Utilization numberPercentage Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
- cpu_
utilization_ intpercentage Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
- cpu
Utilization NumberPercentage Specifies the CPU utilization percentage threshold at which connector scale in should trigger.
ConnectorScaleOutPolicy, ConnectorScaleOutPolicyArgs
- Cpu
Utilization intPercentage Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
- Cpu
Utilization intPercentage Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
- cpu
Utilization IntegerPercentage Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
- cpu
Utilization numberPercentage Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
- cpu_
utilization_ intpercentage Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
- cpu
Utilization NumberPercentage Specifies the CPU utilization percentage threshold at which connector scale out should trigger.
ConnectorVpc, ConnectorVpcArgs
- Security
Groups 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.
- Security
Groups []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 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.
- security
Groups 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.
- security
Groups 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, ConnectorWorkerConfigurationArgs
- Revision int
The revision of the worker configuration to use.
- Worker
Configuration stringArn The Amazon Resource Name (ARN) of the worker configuration to use.
- Revision int
The revision of the worker configuration to use.
- Worker
Configuration stringArn The Amazon Resource Name (ARN) of the worker configuration to use.
- revision Integer
The revision of the worker configuration to use.
- worker
Configuration StringArn The Amazon Resource Name (ARN) of the worker configuration to use.
- revision number
The revision of the worker configuration to use.
- worker
Configuration stringArn The Amazon Resource Name (ARN) of the worker configuration to use.
- revision int
The revision of the worker configuration to use.
- worker_
configuration_ strarn The Amazon Resource Name (ARN) of the worker configuration to use.
- revision Number
The revision of the worker configuration to use.
- worker
Configuration StringArn The Amazon Resource Name (ARN) of the worker configuration to use.
ConnectorWorkerLogDelivery, ConnectorWorkerLogDeliveryArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.