KafkaSettings
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.
Contents
- Broker
-
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 Amazon Database Migration Service in the Amazon Database Migration Service User Guide.Type: String
Required: No
- IncludeControlDetails
-
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is
false
.Type: Boolean
Required: No
- IncludeNullAndEmpty
-
Include NULL and empty columns for records migrated to the endpoint. The default is
false
.Type: Boolean
Required: No
- IncludePartitionValue
-
Shows the partition value within the Kafka message output unless the partition type is
schema-table-type
. The default isfalse
.Type: Boolean
Required: No
- IncludeTableAlterOperations
-
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
, andrename-column
. The default isfalse
.Type: Boolean
Required: No
- IncludeTransactionDetails
-
Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for
transaction_id
, previoustransaction_id
, andtransaction_record_id
(the record offset within a transaction). The default isfalse
.Type: Boolean
Required: No
- MessageFormat
-
The output format for the records created on the endpoint. The message format is
JSON
(default) orJSON_UNFORMATTED
(a single line with no tab).Type: String
Valid Values:
json | json-unformatted
Required: No
- MessageMaxBytes
-
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Type: Integer
Required: No
- NoHexPrefix
-
Set this optional parameter to
true
to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, Amazon DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to a Kafka target. Use theNoHexPrefix
endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.Type: Boolean
Required: No
- PartitionIncludeSchemaTable
-
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 isfalse
.Type: Boolean
Required: No
- SaslMechanism
-
For SASL/SSL authentication, Amazon DMS supports the
SCRAM-SHA-512
mechanism by default. Amazon DMS versions 3.5.0 and later also support thePLAIN
mechanism. To use thePLAIN
mechanism, set this parameter toPLAIN.
Type: String
Valid Values:
scram-sha-512 | plain
Required: No
- SaslPassword
-
The secure password you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
Type: String
Required: No
- SaslUsername
-
The secure user name you created when you first set up your MSK cluster to validate a client identity and make an encrypted connection between server and client using SASL-SSL authentication.
Type: String
Required: No
- SecurityProtocol
-
Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). Options include
ssl-encryption
,ssl-authentication
, andsasl-ssl
.sasl-ssl
requiresSaslUsername
andSaslPassword
.Type: String
Valid Values:
plaintext | ssl-authentication | ssl-encryption | sasl-ssl
Required: No
- SslCaCertificateArn
-
The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that Amazon DMS uses to securely connect to your Kafka target endpoint.
Type: String
Required: No
- SslClientCertificateArn
-
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
Type: String
Required: No
- SslClientKeyArn
-
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
Type: String
Required: No
- SslClientKeyPassword
-
The password for the client private key used to securely connect to a Kafka target endpoint.
Type: String
Required: No
- SslEndpointIdentificationAlgorithm
-
Sets hostname verification for the certificate. This setting is supported in Amazon DMS version 3.5.1 and later.
Type: String
Valid Values:
none | https
Required: No
- Topic
-
The topic to which you migrate the data. If you don't specify a topic, Amazon DMS specifies
"kafka-default-topic"
as the migration topic.Type: String
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: