interface KafkaSettingsProperty

Language	Type name
.NET	`Amazon.CDK.AWS.DMS.CfnEndpoint.KafkaSettingsProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnEndpoint_KafkaSettingsProperty`
Java	`software.amazon.awscdk.services.dms.CfnEndpoint.KafkaSettingsProperty`
Python	`aws_cdk.aws_dms.CfnEndpoint.KafkaSettingsProperty`
TypeScript	`aws-cdk-lib` » `aws_dms` » `CfnEndpoint` » `KafkaSettingsProperty`

Provides information that describes an Apache Kafka endpoint.

This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For more information about other available settings, see Using object mapping to migrate data to a Kafka topic in the AWS Database Migration Service User Guide .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const kafkaSettingsProperty: dms.CfnEndpoint.KafkaSettingsProperty = {
  broker: 'broker',
  includeControlDetails: false,
  includeNullAndEmpty: false,
  includePartitionValue: false,
  includeTableAlterOperations: false,
  includeTransactionDetails: false,
  messageFormat: 'messageFormat',
  messageMaxBytes: 123,
  noHexPrefix: false,
  partitionIncludeSchemaTable: false,
  saslPassword: 'saslPassword',
  saslUserName: 'saslUserName',
  securityProtocol: 'securityProtocol',
  sslCaCertificateArn: 'sslCaCertificateArn',
  sslClientCertificateArn: 'sslClientCertificateArn',
  sslClientKeyArn: 'sslClientKeyArn',
  sslClientKeyPassword: 'sslClientKeyPassword',
  topic: 'topic',
};

Properties

Name	Type	Description
broker?	`string`	A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.
includeControlDetails?	`boolean \|` `IResolvable`	Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
includeNullAndEmpty?	`boolean \|` `IResolvable`	Include NULL and empty columns for records migrated to the endpoint.
includePartitionValue?	`boolean \|` `IResolvable`	Shows the partition value within the Kafka message output unless the partition type is `schema-table-type` .
includeTableAlterOperations?	`boolean \|` `IResolvable`	Includes any data definition language (DDL) operations that change the table in the control data, such as `rename-table` , `drop-table` , `add-column` , `drop-column` , and `rename-column` .
includeTransactionDetails?	`boolean \|` `IResolvable`	Provides detailed transaction information from the source database.
messageFormat?	`string`	The output format for the records created on the endpoint.
messageMaxBytes?	`number`	The maximum size in bytes for records created on the endpoint The default is 1,000,000.
noHexPrefix?	`boolean \|` `IResolvable`	Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
partitionIncludeSchemaTable?	`boolean \|` `IResolvable`	Prefixes schema and table names to partition values, when the partition type is `primary-key-type` .
saslPassword?	`string`	The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
saslUserName?	`string`	The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
securityProtocol?	`string`	Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
sslCaCertificateArn?	`string`	The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
sslClientCertificateArn?	`string`	The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
sslClientKeyArn?	`string`	The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
sslClientKeyPassword?	`string`	The password for the client private key used to securely connect to a Kafka target endpoint.
topic?	`string`	The topic to which you migrate the data.

broker?

Type: string (optional)

A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.

Specify each broker location in the form *broker-hostname-or-ip* : *port* . For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345" . For more information and examples of specifying a list of broker locations, see Using Apache Kafka as a target for AWS Database Migration Service in the AWS Database Migration Service User Guide .

includeControlDetails?

Type: boolean | IResolvable (optional)

Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.

The default is false .

includeNullAndEmpty?

Type: boolean | IResolvable (optional)

Include NULL and empty columns for records migrated to the endpoint.

The default is false .

includePartitionValue?

Type: boolean | IResolvable (optional)

Shows the partition value within the Kafka message output unless the partition type is schema-table-type .

The default is false .

includeTableAlterOperations?

Type: boolean | IResolvable (optional)

Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table , drop-table , add-column , drop-column , and rename-column .

The default is false .

includeTransactionDetails?

Type: boolean | IResolvable (optional)

Provides detailed transaction information from the source database.

This information includes a commit timestamp, a log position, and values for transaction_id , previous transaction_id , and transaction_record_id (the record offset within a transaction). The default is false .

messageFormat?

Type: string (optional)

The output format for the records created on the endpoint.

The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

messageMaxBytes?

Type: number (optional)

The maximum size in bytes for records created on the endpoint The default is 1,000,000.

noHexPrefix?

Type: boolean | IResolvable (optional)

Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format.

For example, by default, AWS DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use the NoHexPrefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

partitionIncludeSchemaTable?

Type: boolean | IResolvable (optional)

Prefixes schema and table names to partition values, when the partition type is primary-key-type .

Doing this increases data distribution among Kafka partitions. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same partition, which causes throttling. The default is false .

saslPassword?

Type: string (optional)

The secure password that you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

saslUserName?

Type: string (optional)

The secure user name you created when you first set up your Amazon MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.

securityProtocol?

Type: string (optional)

Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).

Options include ssl-encryption , ssl-authentication , and sasl-ssl . sasl-ssl requires SaslUsername and SaslPassword .

sslCaCertificateArn?

Type: string (optional)

The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.

sslClientCertificateArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.

sslClientKeyArn?

Type: string (optional)

The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.

sslClientKeyPassword?

Type: string (optional)

The password for the client private key used to securely connect to a Kafka target endpoint.

topic?

Type: string (optional)

The topic to which you migrate the data.

If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.