This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::KafkaConnect::Connector
Creates a connector using the specified properties.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::KafkaConnect::Connector", "Properties" : { "Capacity" :Capacity, "ConnectorConfiguration" :{, "ConnectorDescription" :Key:Value, ...}String, "ConnectorName" :String, "KafkaCluster" :KafkaCluster, "KafkaClusterClientAuthentication" :KafkaClusterClientAuthentication, "KafkaClusterEncryptionInTransit" :KafkaClusterEncryptionInTransit, "KafkaConnectVersion" :String, "LogDelivery" :LogDelivery, "Plugins" :[ Plugin, ... ], "ServiceExecutionRoleArn" :String, "Tags" :[ Tag, ... ], "WorkerConfiguration" :WorkerConfiguration} }
YAML
Type: AWS::KafkaConnect::Connector Properties: Capacity:CapacityConnectorConfiguration:ConnectorDescription:Key:ValueStringConnectorName:StringKafkaCluster:KafkaClusterKafkaClusterClientAuthentication:KafkaClusterClientAuthenticationKafkaClusterEncryptionInTransit:KafkaClusterEncryptionInTransitKafkaConnectVersion:StringLogDelivery:LogDeliveryPlugins:- PluginServiceExecutionRoleArn:StringTags:- TagWorkerConfiguration:WorkerConfiguration
Properties
Capacity-
The connector's compute capacity settings.
Required: Yes
Type: Capacity
Update requires: No interruption
ConnectorConfiguration-
The configuration of the connector.
Required: Yes
Type: Object of String
Pattern:
.*Update requires: No interruption
ConnectorDescription-
The description of the connector.
Required: No
Type: String
Maximum:
1024Update requires: Replacement
ConnectorName-
The name of the connector.
The connector name must be unique and can include up to 128 characters. Valid characters you can include in a connector name are: a-z, A-Z, 0-9, and -.
Required: Yes
Type: String
Minimum:
1Maximum:
128Update requires: Replacement
KafkaCluster-
The details of the Apache Kafka cluster to which the connector is connected.
Required: Yes
Type: KafkaCluster
Update requires: Replacement
KafkaClusterClientAuthentication-
The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.
Required: Yes
Type: KafkaClusterClientAuthentication
Update requires: Replacement
KafkaClusterEncryptionInTransit-
Details of encryption in transit to the Apache Kafka cluster.
Required: Yes
Type: KafkaClusterEncryptionInTransit
Update requires: Replacement
KafkaConnectVersion-
The version of Kafka Connect. It has to be compatible with both the Apache Kafka cluster's version and the plugins.
Required: Yes
Type: String
Update requires: Replacement
LogDelivery-
The settings for delivering connector logs to Amazon CloudWatch Logs.
Required: No
Type: LogDelivery
Update requires: Replacement
Plugins-
Specifies which plugin to use for the connector. You must specify a single-element list. Amazon MSK Connect does not currently support specifying multiple plugins.
Required: Yes
Type: Array of Plugin
Minimum:
1Update requires: Replacement
ServiceExecutionRoleArn-
The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
Required: Yes
Type: String
Pattern:
arn:(aws|aws-us-gov|aws-cn):iam:.*Update requires: Replacement
Property description not available.
Required: No
Type: Array of Tag
Update requires: No interruption
WorkerConfiguration-
The worker configurations that are in use with the connector.
Required: No
Type: WorkerConfiguration
Update requires: Replacement
Return values
Ref
Fn::GetAtt
ConnectorArn-
The Amazon Resource Name (ARN) of the newly created connector.
