CfnConnectorProps Struct
Properties for defining a CfnConnector.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kafkaconnect as kafkaconnect } from 'aws-cdk-lib';
const cfnConnectorProps: kafkaconnect.CfnConnectorProps = {
capacity: {
autoScaling: {
maxWorkerCount: 123,
mcuCount: 123,
minWorkerCount: 123,
scaleInPolicy: {
cpuUtilizationPercentage: 123,
},
scaleOutPolicy: {
cpuUtilizationPercentage: 123,
},
// the properties below are optional
maxAutoscalingTaskCount: 123,
},
provisionedCapacity: {
mcuCount: 123,
workerCount: 123,
},
},
connectorConfiguration: {
connectorConfigurationKey: 'connectorConfiguration',
},
connectorName: 'connectorName',
kafkaCluster: {
apacheKafkaCluster: {
bootstrapServers: 'bootstrapServers',
vpc: {
securityGroups: ['securityGroups'],
subnets: ['subnets'],
},
},
},
kafkaClusterClientAuthentication: {
authenticationType: 'authenticationType',
},
kafkaClusterEncryptionInTransit: {
encryptionType: 'encryptionType',
},
kafkaConnectVersion: 'kafkaConnectVersion',
plugins: [{
customPlugin: {
customPluginArn: 'customPluginArn',
revision: 123,
},
}],
serviceExecutionRoleArn: 'serviceExecutionRoleArn',
// the properties below are optional
connectorDescription: 'connectorDescription',
logDelivery: {
workerLogDelivery: {
cloudWatchLogs: {
enabled: false,
// the properties below are optional
logGroup: 'logGroup',
},
firehose: {
enabled: false,
// the properties below are optional
deliveryStream: 'deliveryStream',
},
s3: {
enabled: false,
// the properties below are optional
bucket: 'bucket',
prefix: 'prefix',
},
},
},
networkType: 'networkType',
tags: [{
key: 'key',
value: 'value',
}],
workerConfiguration: {
revision: 123,
workerConfigurationArn: 'workerConfigurationArn',
},
};
Properties
capacityIResolvable | CfnConnector.CapacityPropertycapacitytyping.Union[IResolvable, CapacityProperty]capacityIResolvableCapacityIResolvableCapacityinterface{}required#The connector's compute capacity settings.
connectorConfigurationIResolvable | { [key: string]: string }connector_configurationtyping.Union[IResolvable, typing.Mapping[str, str]]connectorConfigurationIResolvableConnectorConfigurationIResolvableConnectorConfigurationinterface{}required#The configuration of the connector.
connectorDescriptionstringconnector_descriptionstrconnectorDescriptionStringConnectorDescriptionstringConnectorDescription*string#The description of the connector.
connectorNamestringconnector_namestrconnectorNameStringConnectorNamestringConnectorName*stringrequired#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 -.
kafkaClusterIResolvable | CfnConnector.KafkaClusterPropertykafka_clustertyping.Union[IResolvable, KafkaClusterProperty]kafkaClusterIResolvableKafkaClusterIResolvableKafkaClusterinterface{}required#The details of the Apache Kafka cluster to which the connector is connected.
kafkaClusterClientAuthenticationIResolvable | CfnConnector.KafkaClusterClientAuthenticationPropertykafka_cluster_client_authenticationtyping.Union[IResolvable, KafkaClusterClientAuthenticationProperty]kafkaClusterClientAuthenticationIResolvableKafkaClusterClientAuthenticationIResolvableKafkaClusterClientAuthenticationinterface{}required#The type of client authentication used to connect to the Apache Kafka cluster.
The value is NONE when no client authentication is used.
kafkaClusterEncryptionInTransitIResolvable | CfnConnector.KafkaClusterEncryptionInTransitPropertykafka_cluster_encryption_in_transittyping.Union[IResolvable, KafkaClusterEncryptionInTransitProperty]kafkaClusterEncryptionInTransitIResolvableKafkaClusterEncryptionInTransitIResolvableKafkaClusterEncryptionInTransitinterface{}required#Details of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersionstringkafka_connect_versionstrkafkaConnectVersionStringKafkaConnectVersionstringKafkaConnectVersion*stringrequired#The version of Kafka Connect.
It has to be compatible with both the Apache Kafka cluster's version and the plugins.
logDeliveryIResolvable | CfnConnector.LogDeliveryPropertylog_deliverytyping.Union[IResolvable, LogDeliveryProperty]logDeliveryIResolvableLogDeliveryIResolvableLogDeliveryinterface{}#The settings for delivering connector logs to Amazon CloudWatch Logs.
The network type of the connector.
It gives connectors connectivity to either IPv4 (IPV4) or IPv4 and IPv6 (DUAL) destinations. Defaults to IPV4.
pluginsIResolvable | IResolvable | CfnConnector.PluginProperty[]pluginstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PluginProperty]]]pluginsIResolvablePluginsIResolvablePluginsinterface{}required#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.
serviceExecutionRoleArnstringservice_execution_role_arnstrserviceExecutionRoleArnStringServiceExecutionRoleArnstringServiceExecutionRoleArn*stringrequired#The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
A collection of tags associated with a resource.
workerConfigurationIResolvable | CfnConnector.WorkerConfigurationPropertyworker_configurationtyping.Union[IResolvable, WorkerConfigurationProperty]workerConfigurationIResolvableWorkerConfigurationIResolvableWorkerConfigurationinterface{}#The worker configurations that are in use with the connector.