interface CfnConnectorMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.KafkaConnect.Mixins.CfnConnectorMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awskafkaconnect/mixins#CfnConnectorMixinProps
Java	software.amazon.awscdk.mixins.preview.services.kafkaconnect.mixins.CfnConnectorMixinProps
Python	aws_cdk.mixins_preview.aws_kafkaconnect.mixins.CfnConnectorMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_kafkaconnect » mixins » CfnConnectorMixinProps

Properties for CfnConnectorPropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as kafkaconnect_mixins } from '@aws-cdk/mixins-preview/aws-kafkaconnect';
const cfnConnectorMixinProps: kafkaconnect_mixins.CfnConnectorMixinProps = {
  capacity: {
    autoScaling: {
      maxWorkerCount: 123,
      mcuCount: 123,
      minWorkerCount: 123,
      scaleInPolicy: {
        cpuUtilizationPercentage: 123,
      },
      scaleOutPolicy: {
        cpuUtilizationPercentage: 123,
      },
    },
    provisionedCapacity: {
      mcuCount: 123,
      workerCount: 123,
    },
  },
  connectorConfiguration: {
    connectorConfigurationKey: 'connectorConfiguration',
  },
  connectorDescription: 'connectorDescription',
  connectorName: 'connectorName',
  kafkaCluster: {
    apacheKafkaCluster: {
      bootstrapServers: 'bootstrapServers',
      vpc: {
        securityGroups: ['securityGroups'],
        subnets: ['subnets'],
      },
    },
  },
  kafkaClusterClientAuthentication: {
    authenticationType: 'authenticationType',
  },
  kafkaClusterEncryptionInTransit: {
    encryptionType: 'encryptionType',
  },
  kafkaConnectVersion: 'kafkaConnectVersion',
  logDelivery: {
    workerLogDelivery: {
      cloudWatchLogs: {
        enabled: false,
        logGroup: 'logGroup',
      },
      firehose: {
        deliveryStream: 'deliveryStream',
        enabled: false,
      },
      s3: {
        bucket: 'bucket',
        enabled: false,
        prefix: 'prefix',
      },
    },
  },
  plugins: [{
    customPlugin: {
      customPluginArn: 'customPluginArn',
      revision: 123,
    },
  }],
  serviceExecutionRoleArn: 'serviceExecutionRoleArn',
  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.
connectorDescription?	string	The description 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.
logDelivery?	IResolvable | LogDeliveryProperty	The settings for delivering connector logs to Amazon CloudWatch Logs.
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.
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 (optional)

The connector's compute capacity settings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-capacity

---

connectorConfiguration?

Type: { [string]: string } | IResolvable (optional)

The configuration of the connector.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectorconfiguration

---

connectorDescription?

Type: string (optional)

The description of the connector.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectordescription

---

connectorName?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-connectorname

---

kafkaCluster?

Type: IResolvable | KafkaClusterProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkacluster

---

kafkaClusterClientAuthentication?

Type: IResolvable | KafkaClusterClientAuthenticationProperty (optional)

The type of client authentication used to connect to the Apache Kafka cluster.

The value is NONE when no client authentication is used.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaclusterclientauthentication

---

kafkaClusterEncryptionInTransit?

Type: IResolvable | KafkaClusterEncryptionInTransitProperty (optional)

Details of encryption in transit to the Apache Kafka cluster.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaclusterencryptionintransit

---

kafkaConnectVersion?

Type: string (optional)

The version of Kafka Connect.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-kafkaconnectversion

---

logDelivery?

Type: IResolvable | LogDeliveryProperty (optional)

The settings for delivering connector logs to Amazon CloudWatch Logs.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-logdelivery

---

plugins?

Type: IResolvable | (IResolvable | PluginProperty)[] (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-plugins

---

serviceExecutionRoleArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-serviceexecutionrolearn

---

tags?

Type: CfnTag[] (optional)

A collection of tags associated with a resource.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-tags

---

workerConfiguration?

Type: IResolvable | WorkerConfigurationProperty (optional)

The worker configurations that are in use with the connector.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kafkaconnect-connector.html#cfn-kafkaconnect-connector-workerconfiguration