AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::KafkaConnect::Connector

CfnConnector

Creates a connector using the specified properties.

Import

import { CfnConnector } from 'aws-cdk-lib/aws-kafkaconnect';

Or use the module namespace:

import * as kafkaconnect from 'aws-cdk-lib/aws-kafkaconnect';
// kafkaconnect.CfnConnector

Properties

Configuration passed to the constructor as CfnConnectorProps.

capacityRequired
IResolvable | CapacityProperty

The connector's compute capacity settings.

connectorConfigurationRequired
{ [key: string]: string } | IResolvable

The configuration of the connector.

connectorNameRequired
string

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 -.

kafkaClusterRequired
IResolvable | KafkaClusterProperty

The details of the Apache Kafka cluster to which the connector is connected.

kafkaClusterClientAuthenticationRequired
IResolvable | KafkaClusterClientAuthenticationProperty

The type of client authentication used to connect to the Apache Kafka cluster. The value is NONE when no client authentication is used.

kafkaClusterEncryptionInTransitRequired
IResolvable | KafkaClusterEncryptionInTransitProperty

Details of encryption in transit to the Apache Kafka cluster.

kafkaConnectVersionRequired
string

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

pluginsRequired
IResolvable | IResolvable | PluginProperty[]

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.

serviceExecutionRoleArnRequired
string

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

connectorDescriptionOptional
string

The description of the connector.

logDeliveryOptional
IResolvable | LogDeliveryProperty

The settings for delivering connector logs to Amazon CloudWatch Logs.

networkTypeOptional
string

The network type of the connector. It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.

tagsOptional
CfnTag[]

A collection of tags associated with a resource.

workerConfigurationOptional
IResolvable | WorkerConfigurationProperty

The worker configurations that are in use with the connector.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::KafkaConnect::ConnectorView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-kafkaconnect
CFN TypeAWS::KafkaConnect::Connector
Properties14

Related Constructs

Explore This Service

External Links