EndpointKafkaSettings class

Constructors

EndpointKafkaSettings({required Input<String> broker, Input<bool?>? includeControlDetails, Input<bool?>? includeNullAndEmpty, Input<bool?>? includePartitionValue, Input<bool?>? includeTableAlterOperations, Input<bool?>? includeTransactionDetails, Input<String?>? messageFormat, Input<int?>? messageMaxBytes, Input<bool?>? noHexPrefix, Input<bool?>? partitionIncludeSchemaTable, Input<String?>? saslMechanism, Input<String?>? saslPassword, Input<String?>? saslUsername, Input<String?>? securityProtocol, Input<String?>? sslCaCertificateArn, Input<String?>? sslClientCertificateArn, Input<String?>? sslClientKeyArn, Input<String?>? sslClientKeyPassword, Input<String?>? topic})
Creates a new EndpointKafkaSettings. broker Kafka broker location. Specify in the form broker-hostname-or-ip:port. includeControlDetails Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. Default is false. includeNullAndEmpty Include NULL and empty columns for records migrated to the endpoint. Default is false. includePartitionValue Shows the partition value within the Kafka message output unless the partition type is schema-table-type. Default is false. 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, and rename-column. Default is false. includeTransactionDetails Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transactionId, previous transactionId, and transactionRecordId (the record offset within a transaction). Default is false. messageFormat Output format for the records created on the endpoint. Message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab). messageMaxBytes Maximum size in bytes for records created on the endpoint Default is 1,000,000. noHexPrefix 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 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. saslMechanism For SASL/SSL authentication, AWS DMS supports the scram-sha-512 mechanism by default. AWS DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to plain. saslPassword 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 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 Set secure connection to a Kafka target endpoint using TLS. Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires saslUsername and saslPassword. sslCaCertificateArn ARN for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint. sslClientCertificateArn ARN of the client certificate used to securely connect to a Kafka target endpoint. sslClientKeyArn ARN for the client private key used to securely connect to a Kafka target endpoint. sslClientKeyPassword Password for the client private key used to securely connect to a Kafka target endpoint. topic Kafka topic for migration. Default is kafka-default-topic.
const
EndpointKafkaSettings.fromMap(Map<String, dynamic> map)
factory

Properties

broker → Input<String>
Kafka broker location. Specify in the form broker-hostname-or-ip:port.
final
hashCode → int
The hash code for this object.
no setterinherited
includeControlDetails → Input<bool?>?
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. Default is false.
final
includeNullAndEmpty → Input<bool?>?
Include NULL and empty columns for records migrated to the endpoint. Default is false.
final
includePartitionValue → Input<bool?>?
Shows the partition value within the Kafka message output unless the partition type is schema-table-type. Default is false.
final
includeTableAlterOperations → Input<bool?>?
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.
final
includeTransactionDetails → Input<bool?>?
Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transactionId, previous transactionId, and transactionRecordId (the record offset within a transaction). Default is false.
final
messageFormat → Input<String?>?
Output format for the records created on the endpoint. Message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).
final
messageMaxBytes → Input<int?>?
Maximum size in bytes for records created on the endpoint Default is 1,000,000.
final
noHexPrefix → Input<bool?>?
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.
final
partitionIncludeSchemaTable → Input<bool?>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saslMechanism → Input<String?>?
For SASL/SSL authentication, AWS DMS supports the scram-sha-512 mechanism by default. AWS DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to plain.
final
saslPassword → Input<String?>?
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.
final
saslUsername → Input<String?>?
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.
final
securityProtocol → Input<String?>?
Set secure connection to a Kafka target endpoint using TLS. Options include ssl-encryption, ssl-authentication, and sasl-ssl. sasl-ssl requires saslUsername and saslPassword.
final
sslCaCertificateArn → Input<String?>?
ARN for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
final
sslClientCertificateArn → Input<String?>?
ARN of the client certificate used to securely connect to a Kafka target endpoint.
final
sslClientKeyArn → Input<String?>?
ARN for the client private key used to securely connect to a Kafka target endpoint.
final
sslClientKeyPassword → Input<String?>?
Password for the client private key used to securely connect to a Kafka target endpoint.
final
topic → Input<String?>?
Kafka topic for migration. Default is kafka-default-topic.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited