Interface CfnEndpoint.IKafkaSettingsProperty
Provides information that describes an Apache Kafka endpoint.
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public interface IKafkaSettingsProperty
Syntax (vb)
Public Interface IKafkaSettingsProperty
Remarks
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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var kafkaSettingsProperty = new 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"
};
Synopsis
Properties
Broker | A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance. |
IncludeControlDetails | Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. |
IncludeNullAndEmpty | Include NULL and empty columns for records migrated to the endpoint. |
IncludePartitionValue | Shows the partition value within the Kafka message output unless the partition type is |
IncludeTableAlterOperations | Includes any data definition language (DDL) operations that change the table in the control data, such as |
IncludeTransactionDetails | Provides detailed transaction information from the source database. |
MessageFormat | The output format for the records created on the endpoint. |
MessageMaxBytes | The maximum size in bytes for records created on the endpoint The default is 1,000,000. |
NoHexPrefix | Set this optional parameter to |
PartitionIncludeSchemaTable | Prefixes schema and table names to partition values, when the partition type is |
SaslPassword | 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 | 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 | Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS). |
SslCaCertificateArn | 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 | The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint. |
SslClientKeyArn | The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint. |
SslClientKeyPassword | The password for the client private key used to securely connect to a Kafka target endpoint. |
Topic | The topic to which you migrate the data. |
Properties
Broker
A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.
virtual string Broker { get; }
Property Value
System.String
Remarks
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
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
virtual object IncludeControlDetails { get; }
Property Value
System.Object
Remarks
IncludeNullAndEmpty
Include NULL and empty columns for records migrated to the endpoint.
virtual object IncludeNullAndEmpty { get; }
Property Value
System.Object
Remarks
IncludePartitionValue
Shows the partition value within the Kafka message output unless the partition type is schema-table-type
.
virtual object IncludePartitionValue { get; }
Property Value
System.Object
Remarks
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
.
virtual object IncludeTableAlterOperations { get; }
Property Value
System.Object
Remarks
IncludeTransactionDetails
Provides detailed transaction information from the source database.
virtual object IncludeTransactionDetails { get; }
Property Value
System.Object
Remarks
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
The output format for the records created on the endpoint.
virtual string MessageFormat { get; }
Property Value
System.String
Remarks
The message format is JSON
(default) or JSON_UNFORMATTED
(a single line with no tab).
MessageMaxBytes
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
virtual Nullable<double> MessageMaxBytes { get; }
Property Value
System.Nullable<System.Double>
Remarks
NoHexPrefix
Set this optional parameter to true
to avoid adding a '0x' prefix to raw data in hexadecimal format.
virtual object NoHexPrefix { get; }
Property Value
System.Object
Remarks
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
.
virtual object PartitionIncludeSchemaTable { get; }
Property Value
System.Object
Remarks
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
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.
virtual string SaslPassword { get; }
Property Value
System.String
Remarks
SaslUserName
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.
virtual string SaslUserName { get; }
Property Value
System.String
Remarks
SecurityProtocol
Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
virtual string SecurityProtocol { get; }
Property Value
System.String
Remarks
Options include ssl-encryption
, ssl-authentication
, and sasl-ssl
. sasl-ssl
requires SaslUsername
and SaslPassword
.
SslCaCertificateArn
The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
virtual string SslCaCertificateArn { get; }
Property Value
System.String
Remarks
SslClientCertificateArn
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
virtual string SslClientCertificateArn { get; }
Property Value
System.String
Remarks
SslClientKeyArn
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
virtual string SslClientKeyArn { get; }
Property Value
System.String
Remarks
SslClientKeyPassword
The password for the client private key used to securely connect to a Kafka target endpoint.
virtual string SslClientKeyPassword { get; }
Property Value
System.String
Remarks
Topic
The topic to which you migrate the data.
virtual string Topic { get; }
Property Value
System.String
Remarks
If you don't specify a topic, AWS DMS specifies "kafka-default-topic"
as the migration topic.