Package 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(Stable)
public static interface CfnEndpoint.KafkaSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that describes an Apache Kafka endpoint.

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 .

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)
         .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")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnEndpoint.KafkaSettingsProperty.Builder	builder()
default String	getBroker()	A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.
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	getIncludePartitionValue()	Shows the partition value within the Kafka message output unless the partition type is schema-table-type .
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 String	getMessageFormat()	The output format for the records created on the endpoint.
default Number	getMessageMaxBytes()	The maximum size in bytes for records created on the endpoint The default is 1,000,000.
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 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.
default String	getSaslUserName()	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.
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()	The topic to which you migrate the data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBroker

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

A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-broker

getIncludeControlDetails

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includecontroldetails

getIncludeNullAndEmpty

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

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

The default is false .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includenullandempty

getIncludePartitionValue

@Stability(Stable)
@Nullable
default Object getIncludePartitionValue()

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

The default is false .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includepartitionvalue

getIncludeTableAlterOperations

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includetablealteroperations

getIncludeTransactionDetails

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-includetransactiondetails

getMessageFormat

@Stability(Stable)
@Nullable
default String getMessageFormat()

The output format for the records created on the endpoint.

The message format is JSON (default) or JSON_UNFORMATTED (a single line with no tab).

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-messageformat

getMessageMaxBytes

@Stability(Stable)
@Nullable
default Number getMessageMaxBytes()

The maximum size in bytes for records created on the endpoint The default is 1,000,000.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-messagemaxbytes

getNoHexPrefix

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-nohexprefix

getPartitionIncludeSchemaTable

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-partitionincludeschematable

getSaslPassword

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-saslpassword

getSaslUserName

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-saslusername

getSecurityProtocol

@Stability(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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-securityprotocol

getSslCaCertificateArn

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslcacertificatearn

getSslClientCertificateArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientcertificatearn

getSslClientKeyArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientkeyarn

getSslClientKeyPassword

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-sslclientkeypassword

getTopic

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

The topic to which you migrate the data.

If you don't specify a topic, AWS DMS specifies "kafka-default-topic" as the migration topic.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-endpoint-kafkasettings.html#cfn-dms-endpoint-kafkasettings-topic

builder

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

Returns:

a CfnEndpoint.KafkaSettingsProperty.Builder of CfnEndpoint.KafkaSettingsProperty