interface CfnConnectorProps

Language	Type name
.NET	`Amazon.CDK.AWS.KafkaConnect.CfnConnectorProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awskafkaconnect#CfnConnectorProps`
Java	`software.amazon.awscdk.services.kafkaconnect.CfnConnectorProps`
Python	`aws_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',
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workerConfiguration: {
    revision: 123,
    workerConfigurationArn: 'workerConfigurationArn',
  },
};

Properties

Name	Type	Description
capacity	`IResolvable` `\|` `CapacityProperty`	The connector's compute capacity settings.
connectorConfiguration	`{ [string]: string } \|` `IResolvable`	The configuration of the connector.
connectorName	`string`	The name of the connector.
kafkaCluster	`IResolvable` `\|` `KafkaClusterProperty`	The details of the Apache Kafka cluster to which the connector is connected.
kafkaClusterClientAuthentication	`IResolvable` `\|` `KafkaClusterClientAuthenticationProperty`	The type of client authentication used to connect to the Apache Kafka cluster.
kafkaClusterEncryptionInTransit	`IResolvable` `\|` `KafkaClusterEncryptionInTransitProperty`	Details of encryption in transit to the Apache Kafka cluster.
kafkaConnectVersion	`string`	The version of Kafka Connect.
plugins	`IResolvable` `\| (IResolvable` `\|` `PluginProperty)[]`	Specifies which plugin to use for the connector.
serviceExecutionRoleArn	`string`	The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.
connectorDescription?	`string`	The description of the connector.
logDelivery?	`IResolvable` `\|` `LogDeliveryProperty`	The settings for delivering connector logs to Amazon CloudWatch Logs.
tags?	`CfnTag[]`	A collection of tags associated with a resource.
workerConfiguration?	`IResolvable` `\|` `WorkerConfigurationProperty`	The worker configurations that are in use with the connector.

capacity

Type: IResolvable | CapacityProperty

The connector's compute capacity settings.

connectorConfiguration

Type: { [string]: string } | IResolvable

The configuration of the connector.

connectorName

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