AWS Fundamentals Logo
AWS Fundamentals
AWS::KafkaConnect::Connector

KafkaConnect Connector

Resource Type definition for AWS::KafkaConnect::Connector

Properties

14 configurable properties. 9 required. Click a row to see details.

Filter:
PropertyTypeFlags
Capacity
Capacity
Required
ConnectorConfiguration
object
Required
ConnectorName
string
RequiredCreate-only
KafkaCluster
KafkaCluster
RequiredCreate-only
KafkaClusterClientAuthentication
KafkaClusterClientAuthentication
RequiredCreate-only
KafkaClusterEncryptionInTransit
KafkaClusterEncryptionInTransit
RequiredCreate-only
KafkaConnectVersion
string
RequiredCreate-only
Plugins
Array<Plugin>
RequiredCreate-only
ServiceExecutionRoleArn
string
RequiredCreate-only
ConnectorDescription
string
Create-only
LogDelivery
LogDelivery
Create-only
NetworkType
string
Create-only
Tags
Array<Tag>
WorkerConfiguration
WorkerConfiguration
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
ConnectorArnstringAmazon Resource Name for the created Connector.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::KafkaConnect::Connector

Resources:
  MyResource:
    Type: AWS::KafkaConnect::Connector
    Properties:
      Capacity: "value"
      ConnectorConfiguration: {}
      ConnectorName: "my-connectorname"
      KafkaConnectVersion: "value"
      KafkaCluster: "value"
      KafkaClusterClientAuthentication: "value"
      KafkaClusterEncryptionInTransit: "value"
      Plugins: []
      ServiceExecutionRoleArn: "arn:aws:service:region:account:resource"
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

kafkaconnect:CreateConnectorkafkaconnect:DescribeConnectorkafkaconnect:TagResourcekafkaconnect:ListTagsForResourceiam:CreateServiceLinkedRoleiam:PassRoleec2:CreateNetworkInterfaceec2:DescribeSecurityGroups

read

kafkaconnect:DescribeConnectorkafkaconnect:ListTagsForResource

delete

kafkaconnect:DeleteConnectorkafkaconnect:DescribeConnectorlogs:DeleteLogDeliverylogs:GetLogDeliverylogs:ListLogDeliveries

update

kafkaconnect:UpdateConnectorkafkaconnect:DescribeConnectorkafkaconnect:DescribeConnectorOperationkafkaconnect:TagResourcekafkaconnect:ListTagsForResourcekafkaconnect:UntagResourceiam:CreateServiceLinkedRolelogs:UpdateLogDelivery

list

kafkaconnect:ListConnectors

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceKafkaConnect
Properties15
Required9
TaggingSupported
Primary IDConnectorArn

Supported Operations

CreateReadDeleteUpdateList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ConnectorDescriptionConnectorNameKafkaClusterKafkaClusterClientAuthenticationKafkaClusterEncryptionInTransitKafkaConnectVersionLogDeliveryPluginsServiceExecutionRoleArnWorkerConfigurationNetworkType

Related Resources

External Links