pulumi-aws-kotlin/com.pulumi.aws.dms.kotlin.outputs/EndpointKafkaSettings

EndpointKafkaSettings

data class EndpointKafkaSettings(val broker: String, val includeControlDetails: Boolean? = null, val includeNullAndEmpty: Boolean? = null, val includePartitionValue: Boolean? = null, val includeTableAlterOperations: Boolean? = null, val includeTransactionDetails: Boolean? = null, val messageFormat: String? = null, val messageMaxBytes: Int? = null, val noHexPrefix: Boolean? = null, val partitionIncludeSchemaTable: Boolean? = null, val saslPassword: String? = null, val saslUsername: String? = null, val securityProtocol: String? = null, val sslCaCertificateArn: String? = null, val sslClientCertificateArn: String? = null, val sslClientKeyArn: String? = null, val sslClientKeyPassword: String? = null, val topic: String? = null)

Constructors

fun EndpointKafkaSettings(broker: String, includeControlDetails: Boolean? = null, includeNullAndEmpty: Boolean? = null, includePartitionValue: Boolean? = null, includeTableAlterOperations: Boolean? = null, includeTransactionDetails: Boolean? = null, messageFormat: String? = null, messageMaxBytes: Int? = null, noHexPrefix: Boolean? = null, partitionIncludeSchemaTable: Boolean? = null, saslPassword: String? = null, saslUsername: String? = null, securityProtocol: String? = null, sslCaCertificateArn: String? = null, sslClientCertificateArn: String? = null, sslClientKeyArn: String? = null, sslClientKeyPassword: String? = null, topic: String? = null)

Types

Companion

object Companion

Properties

broker

val broker: String

Kafka broker location. Specify in the form broker-hostname-or-ip:port.

includeControlDetails

val includeControlDetails: Boolean? = null

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

includeNullAndEmpty

val includeNullAndEmpty: Boolean? = null

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

includePartitionValue

val includePartitionValue: Boolean? = null

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

includeTableAlterOperations

val includeTableAlterOperations: Boolean? = null

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. Default is false.

includeTransactionDetails

val includeTransactionDetails: Boolean? = null

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). Default is false.

messageFormat

val messageFormat: String? = null

Output format for the records created on the endpoint. Message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

messageMaxBytes

val messageMaxBytes: Int? = null

Maximum size in bytes for records created on the endpoint Default is 1,000,000.

noHexPrefix

val noHexPrefix: Boolean? = null

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 no_hex_prefix endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.

partitionIncludeSchemaTable

val partitionIncludeSchemaTable: Boolean? = null

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. Default is false.

saslPassword

val saslPassword: String? = null

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.

saslUsername

val saslUsername: String? = null

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.

securityProtocol

val securityProtocol: String? = null

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 sasl_username and sasl_password.

sslCaCertificateArn

val sslCaCertificateArn: String? = null

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

sslClientCertificateArn

val sslClientCertificateArn: String? = null

ARN of the client certificate used to securely connect to a Kafka target endpoint.

sslClientKeyArn

val sslClientKeyArn: String? = null

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

sslClientKeyPassword

val sslClientKeyPassword: String? = null

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

topic

val topic: String? = null

Kafka topic for migration. Default is kafka-default-topic.