AWS::DMS::Endpoint KafkaSettings - AWS CloudFormation

AWS::DMS::Endpoint KafkaSettings

Not currently supported by AWS CloudFormation.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Broker" : String, "IncludeControlDetails" : Boolean, "IncludeNullAndEmpty" : Boolean, "IncludeTableAlterOperations" : Boolean, "IncludeTransactionDetails" : Boolean, "NoHexPrefix" : Boolean, "PartitionIncludeSchemaTable" : Boolean, "SaslPassword" : String, "SaslUserName" : String, "SecurityProtocol" : String, "SslCaCertificateArn" : String, "SslClientCertificateArn" : String, "SslClientKeyArn" : String, "SslClientKeyPassword" : String, "Topic" : String }

Properties

Broker

Not currently supported by AWS CloudFormation.

Required: No

Type: String

Update requires: No interruption

IncludeControlDetails

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

Required: No

Type: Boolean

Update requires: No interruption

IncludeNullAndEmpty

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

Required: No

Type: Boolean

Update requires: No interruption

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. The default is false.

Required: No

Type: Boolean

Update requires: No interruption

IncludeTransactionDetails

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.

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

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

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

SecurityProtocol

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.

Required: No

Type: String

Allowed values: plaintext | sasl-ssl | ssl-authentication | ssl-encryption

Update requires: No interruption

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.

Required: No

Type: String

Update requires: No interruption

SslClientCertificateArn

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

Required: No

Type: String

Update requires: No interruption

SslClientKeyArn

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

Required: No

Type: String

Update requires: No interruption

SslClientKeyPassword

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

Required: No

Type: String

Update requires: No interruption

Topic

Not currently supported by AWS CloudFormation.

Required: No

Type: String

Update requires: No interruption