software.amazon.awscdk.services.dms

Class CfnEndpoint.KafkaSettingsProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.dms.CfnEndpoint.KafkaSettingsProperty.Jsii$Proxy

All Implemented Interfaces:

CfnEndpoint.KafkaSettingsProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEndpoint.KafkaSettingsProperty

@Stability(value=Stable)
 @Internal
public static final class CfnEndpoint.KafkaSettingsProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEndpoint.KafkaSettingsProperty

An implementation for CfnEndpoint.KafkaSettingsProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.KafkaSettingsProperty

CfnEndpoint.KafkaSettingsProperty.Builder, CfnEndpoint.KafkaSettingsProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(CfnEndpoint.KafkaSettingsProperty.Builder builder) Constructor that initializes the object based on literal property values passed by the CfnEndpoint.DocDbSettingsProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getBroker() A comma-separated list of one or more broker locations in your Kafka cluster that host your Kafka instance.
Object	getIncludeControlDetails() Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output.
Object	getIncludeNullAndEmpty() Include NULL and empty columns for records migrated to the endpoint.
Object	getIncludePartitionValue() Shows the partition value within the Kafka message output unless the partition type is `schema-table-type` .
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` .
Object	getIncludeTransactionDetails() Provides detailed transaction information from the source database.
String	getMessageFormat() The output format for the records created on the endpoint.
Number	getMessageMaxBytes() The maximum size in bytes for records created on the endpoint The default is 1,000,000.
Object	getNoHexPrefix() Set this optional parameter to `true` to avoid adding a '0x' prefix to raw data in hexadecimal format.
Object	getPartitionIncludeSchemaTable() Prefixes schema and table names to partition values, when the partition type is `primary-key-type` .
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.
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.
String	getSecurityProtocol() Set secure connection to a Kafka target endpoint using Transport Layer Security (TLS).
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.
String	getSslClientCertificateArn() The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
String	getSslClientKeyArn() The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
String	getSslClientKeyPassword() The password for the client private key used to securely connect to a Kafka target endpoint.
String	getTopic() The topic to which you migrate the data.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.KafkaSettingsProperty

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEndpoint.KafkaSettingsProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEndpoint.DocDbSettingsProperty.Builder.

Method Detail

getBroker

public final String getBroker()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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 .

Specified by:

getBroker in interface CfnEndpoint.KafkaSettingsProperty

getIncludeControlDetails

public final Object getIncludeControlDetails()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

The default is false .

Specified by:

getIncludeControlDetails in interface CfnEndpoint.KafkaSettingsProperty

getIncludeNullAndEmpty

public final Object getIncludeNullAndEmpty()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

The default is false .

Specified by:

getIncludeNullAndEmpty in interface CfnEndpoint.KafkaSettingsProperty

getIncludePartitionValue

public final Object getIncludePartitionValue()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

The default is false .

Specified by:

getIncludePartitionValue in interface CfnEndpoint.KafkaSettingsProperty

getIncludeTableAlterOperations

public final Object getIncludeTableAlterOperations()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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 .

Specified by:

getIncludeTableAlterOperations in interface CfnEndpoint.KafkaSettingsProperty

getIncludeTransactionDetails

public final Object getIncludeTransactionDetails()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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 .

Specified by:

getIncludeTransactionDetails in interface CfnEndpoint.KafkaSettingsProperty

getMessageFormat

public final String getMessageFormat()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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).

Specified by:

getMessageFormat in interface CfnEndpoint.KafkaSettingsProperty

getMessageMaxBytes

public final Number getMessageMaxBytes()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

Specified by:

getMessageMaxBytes in interface CfnEndpoint.KafkaSettingsProperty

getNoHexPrefix

public final Object getNoHexPrefix()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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.

Specified by:

getNoHexPrefix in interface CfnEndpoint.KafkaSettingsProperty

getPartitionIncludeSchemaTable

public final Object getPartitionIncludeSchemaTable()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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 .

Specified by:

getPartitionIncludeSchemaTable in interface CfnEndpoint.KafkaSettingsProperty

getSaslPassword

public final String getSaslPassword()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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.

Specified by:

getSaslPassword in interface CfnEndpoint.KafkaSettingsProperty

getSaslUserName

public final String getSaslUserName()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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.

Specified by:

getSaslUserName in interface CfnEndpoint.KafkaSettingsProperty

getSecurityProtocol

public final String getSecurityProtocol()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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 .

Specified by:

getSecurityProtocol in interface CfnEndpoint.KafkaSettingsProperty

getSslCaCertificateArn

public final String getSslCaCertificateArn()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

Specified by:

getSslCaCertificateArn in interface CfnEndpoint.KafkaSettingsProperty

getSslClientCertificateArn

public final String getSslClientCertificateArn()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

Specified by:

getSslClientCertificateArn in interface CfnEndpoint.KafkaSettingsProperty

getSslClientKeyArn

public final String getSslClientKeyArn()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

Specified by:

getSslClientKeyArn in interface CfnEndpoint.KafkaSettingsProperty

getSslClientKeyPassword

public final String getSslClientKeyPassword()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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

Specified by:

getSslClientKeyPassword in interface CfnEndpoint.KafkaSettingsProperty

getTopic

public final String getTopic()

Description copied from interface: CfnEndpoint.KafkaSettingsProperty

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.

Specified by:

getTopic in interface CfnEndpoint.KafkaSettingsProperty

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object