software.amazon.awscdk.services.dms

Interface CfnEndpoint.KafkaSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEndpoint.KafkaSettingsProperty.Jsii$Proxy

Enclosing class:

CfnEndpoint

@Stability(value=Stable)
public static interface CfnEndpoint.KafkaSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Not currently supported by AWS CloudFormation .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 KafkaSettingsProperty kafkaSettingsProperty = KafkaSettingsProperty.builder()
         .broker("broker")
         .includeControlDetails(false)
         .includeNullAndEmpty(false)
         .includeTableAlterOperations(false)
         .includeTransactionDetails(false)
         .noHexPrefix(false)
         .partitionIncludeSchemaTable(false)
         .saslPassword("saslPassword")
         .saslUserName("saslUserName")
         .securityProtocol("securityProtocol")
         .sslCaCertificateArn("sslCaCertificateArn")
         .sslClientCertificateArn("sslClientCertificateArn")
         .sslClientKeyArn("sslClientKeyArn")
         .sslClientKeyPassword("sslClientKeyPassword")
         .topic("topic")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEndpoint.KafkaSettingsProperty.Builder A builder for CfnEndpoint.KafkaSettingsProperty
static class	CfnEndpoint.KafkaSettingsProperty.Jsii$Proxy An implementation for CfnEndpoint.KafkaSettingsProperty

Method Summary

Modifier and Type	Method and Description
static CfnEndpoint.KafkaSettingsProperty.Builder	builder()
default String	getBroker() Not currently supported by AWS CloudFormation .
default Object	getIncludeControlDetails() Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
default Object	getIncludeNullAndEmpty() Include NULL and empty columns for records migrated to the endpoint.
default Object	getIncludeTableAlterOperations() 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 Object	getIncludeTransactionDetails() Provides detailed transaction information from the source database.
default Object	getNoHexPrefix() Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
default Object	getPartitionIncludeSchemaTable() Prefixes schema and table names to partition values, when the partition type is `primary-key-type` .
default String	getSaslPassword() 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.
default String	getSaslUserName() 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.
default String	getSecurityProtocol() Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
default String	getSslCaCertificateArn() The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
default String	getSslClientCertificateArn() The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
default String	getSslClientKeyArn() The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
default String	getSslClientKeyPassword() The password for the client private key used to securely connect to a Kafka target endpoint.
default String	getTopic() Not currently supported by AWS CloudFormation .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getBroker

@Stability(value=Stable)
 @Nullable
default String getBroker()

Not currently supported by AWS CloudFormation .

getIncludeControlDetails

@Stability(value=Stable)
 @Nullable
default Object getIncludeControlDetails()

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

The default is false .

getIncludeNullAndEmpty

@Stability(value=Stable)
 @Nullable
default Object getIncludeNullAndEmpty()

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

The default is false .

getIncludeTableAlterOperations

@Stability(value=Stable)
 @Nullable
default Object getIncludeTableAlterOperations()

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 .

getIncludeTransactionDetails

@Stability(value=Stable)
 @Nullable
default Object getIncludeTransactionDetails()

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 .

getNoHexPrefix

@Stability(value=Stable)
 @Nullable
default Object getNoHexPrefix()

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.

getPartitionIncludeSchemaTable

@Stability(value=Stable)
 @Nullable
default Object getPartitionIncludeSchemaTable()

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 .

getSaslPassword

@Stability(value=Stable)
 @Nullable
default String getSaslPassword()

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.

getSaslUserName

@Stability(value=Stable)
 @Nullable
default String getSaslUserName()

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.

getSecurityProtocol

@Stability(value=Stable)
 @Nullable
default String getSecurityProtocol()

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 .

getSslCaCertificateArn

@Stability(value=Stable)
 @Nullable
default String getSslCaCertificateArn()

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

getSslClientCertificateArn

@Stability(value=Stable)
 @Nullable
default String getSslClientCertificateArn()

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

getSslClientKeyArn

@Stability(value=Stable)
 @Nullable
default String getSslClientKeyArn()

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

getSslClientKeyPassword

@Stability(value=Stable)
 @Nullable
default String getSslClientKeyPassword()

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

getTopic

@Stability(value=Stable)
 @Nullable
default String getTopic()

Not currently supported by AWS CloudFormation .

builder

@Stability(value=Stable)
static CfnEndpoint.KafkaSettingsProperty.Builder builder()

Returns:

a CfnEndpoint.KafkaSettingsProperty.Builder of CfnEndpoint.KafkaSettingsProperty