aws-cdk-lib.aws_kafkaconnect.CfnConnectorProps

interface CfnConnectorProps

LanguageType name
.NETAmazon.CDK.AWS.KafkaConnect.CfnConnectorProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awskafkaconnect#CfnConnectorProps
Javasoftware.amazon.awscdk.services.kafkaconnect.CfnConnectorProps
Pythonaws_cdk.aws_kafkaconnect.CfnConnectorProps
TypeScript aws-cdk-lib » aws_kafkaconnect » CfnConnectorProps

Properties for defining a CfnConnector.

Example

// 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,
      },
    },
    provisionedCapacity: {
      workerCount: 123,

      // the properties below are optional
      mcuCount: 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',
      },
    },
  },
  workerConfiguration: {
    revision: 123,
    workerConfigurationArn: 'workerConfigurationArn',
  },
};

Properties

NameTypeDescription
capacityIResolvable | CapacityPropertyThe connector's compute capacity settings.
connectorConfigurationIResolvable | { [string]: string }The configuration of the connector.
connectorNamestringThe name of the connector.
kafkaClusterIResolvable | KafkaClusterPropertyThe details of the Apache Kafka cluster to which the connector is connected.
kafkaClusterClientAuthenticationIResolvable | KafkaClusterClientAuthenticationPropertyThe type of client authentication used to connect to the Apache Kafka cluster.
kafkaClusterEncryptionInTransitIResolvable | KafkaClusterEncryptionInTransitPropertyDetails of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersionstringThe version of Kafka Connect.
pluginsIResolvable | IResolvable | PluginProperty[]Specifies which plugin to use for the connector.
serviceExecutionRoleArnstringThe Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
connectorDescription?stringThe description of the connector.
logDelivery?IResolvable | LogDeliveryPropertyThe settings for delivering connector logs to Amazon CloudWatch Logs.
workerConfiguration?IResolvable | WorkerConfigurationPropertyThe worker configurations that are in use with the connector.

capacity

Type: IResolvable | CapacityProperty

The connector's compute capacity settings.


connectorConfiguration

Type: IResolvable | { [string]: string }

The configuration of the connector.


connectorName

Type: string

The name of the connector.


kafkaCluster

Type: IResolvable | KafkaClusterProperty

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


kafkaClusterClientAuthentication

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


kafkaClusterEncryptionInTransit

Type: IResolvable | KafkaClusterEncryptionInTransitProperty

Details of encryption in transit to the Apache Kafka cluster.


kafkaConnectVersion

Type: string

The version of Kafka Connect.

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


plugins

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


serviceExecutionRoleArn

Type: string

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


connectorDescription?

Type: string (optional)

The description of the connector.


logDelivery?

Type: IResolvable | LogDeliveryProperty (optional)

The settings for delivering connector logs to Amazon CloudWatch Logs.


workerConfiguration?

Type: IResolvable | WorkerConfigurationProperty (optional)

The worker configurations that are in use with the connector.