Package software.amazon.awscdk.services.dms

Class CfnEndpoint.KafkaSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnEndpoint.KafkaSettingsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEndpoint.KafkaSettingsProperty>

Enclosing interface:

CfnEndpoint.KafkaSettingsProperty

@Stability(Stable)
public static final class CfnEndpoint.KafkaSettingsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEndpoint.KafkaSettingsProperty>

A builder for CfnEndpoint.KafkaSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEndpoint.KafkaSettingsProperty.Builder	broker(String broker)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getBroker()
CfnEndpoint.KafkaSettingsProperty	build()	Builds the configured instance.
CfnEndpoint.KafkaSettingsProperty.Builder	includeControlDetails(Boolean includeControlDetails)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeControlDetails()
CfnEndpoint.KafkaSettingsProperty.Builder	includeControlDetails(IResolvable includeControlDetails)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeControlDetails()
CfnEndpoint.KafkaSettingsProperty.Builder	includeNullAndEmpty(Boolean includeNullAndEmpty)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeNullAndEmpty()
CfnEndpoint.KafkaSettingsProperty.Builder	includeNullAndEmpty(IResolvable includeNullAndEmpty)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeNullAndEmpty()
CfnEndpoint.KafkaSettingsProperty.Builder	includePartitionValue(Boolean includePartitionValue)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludePartitionValue()
CfnEndpoint.KafkaSettingsProperty.Builder	includePartitionValue(IResolvable includePartitionValue)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludePartitionValue()
CfnEndpoint.KafkaSettingsProperty.Builder	includeTableAlterOperations(Boolean includeTableAlterOperations)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTableAlterOperations()
CfnEndpoint.KafkaSettingsProperty.Builder	includeTableAlterOperations(IResolvable includeTableAlterOperations)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTableAlterOperations()
CfnEndpoint.KafkaSettingsProperty.Builder	includeTransactionDetails(Boolean includeTransactionDetails)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTransactionDetails()
CfnEndpoint.KafkaSettingsProperty.Builder	includeTransactionDetails(IResolvable includeTransactionDetails)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTransactionDetails()
CfnEndpoint.KafkaSettingsProperty.Builder	messageFormat(String messageFormat)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getMessageFormat()
CfnEndpoint.KafkaSettingsProperty.Builder	messageMaxBytes(Number messageMaxBytes)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getMessageMaxBytes()
CfnEndpoint.KafkaSettingsProperty.Builder	noHexPrefix(Boolean noHexPrefix)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getNoHexPrefix()
CfnEndpoint.KafkaSettingsProperty.Builder	noHexPrefix(IResolvable noHexPrefix)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getNoHexPrefix()
CfnEndpoint.KafkaSettingsProperty.Builder	partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getPartitionIncludeSchemaTable()
CfnEndpoint.KafkaSettingsProperty.Builder	partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getPartitionIncludeSchemaTable()
CfnEndpoint.KafkaSettingsProperty.Builder	saslPassword(String saslPassword)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSaslPassword()
CfnEndpoint.KafkaSettingsProperty.Builder	saslUserName(String saslUserName)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSaslUserName()
CfnEndpoint.KafkaSettingsProperty.Builder	securityProtocol(String securityProtocol)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSecurityProtocol()
CfnEndpoint.KafkaSettingsProperty.Builder	sslCaCertificateArn(String sslCaCertificateArn)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslCaCertificateArn()
CfnEndpoint.KafkaSettingsProperty.Builder	sslClientCertificateArn(String sslClientCertificateArn)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslClientCertificateArn()
CfnEndpoint.KafkaSettingsProperty.Builder	sslClientKeyArn(String sslClientKeyArn)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslClientKeyArn()
CfnEndpoint.KafkaSettingsProperty.Builder	sslClientKeyPassword(String sslClientKeyPassword)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslClientKeyPassword()
CfnEndpoint.KafkaSettingsProperty.Builder	topic(String topic)	Sets the value of CfnEndpoint.KafkaSettingsProperty.getTopic()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

broker

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder broker(String broker)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getBroker()

Parameters:

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

Returns:

this

includeControlDetails

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeControlDetails(Boolean includeControlDetails)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeControlDetails()

Parameters:

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

Returns:

this

includeControlDetails

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeControlDetails(IResolvable includeControlDetails)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeControlDetails()

Parameters:

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

Returns:

this

includeNullAndEmpty

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeNullAndEmpty(Boolean includeNullAndEmpty)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeNullAndEmpty()

Parameters:

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

Returns:

this

includeNullAndEmpty

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeNullAndEmpty(IResolvable includeNullAndEmpty)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeNullAndEmpty()

Parameters:

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

Returns:

this

includePartitionValue

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includePartitionValue(Boolean includePartitionValue)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludePartitionValue()

Parameters:

includePartitionValue - Shows the partition value within the Kafka message output unless the partition type is schema-table-type . The default is false .

Returns:

this

includePartitionValue

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includePartitionValue(IResolvable includePartitionValue)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludePartitionValue()

Parameters:

includePartitionValue - Shows the partition value within the Kafka message output unless the partition type is schema-table-type . The default is false .

Returns:

this

includeTableAlterOperations

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeTableAlterOperations(Boolean includeTableAlterOperations)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTableAlterOperations()

Parameters:

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 .

Returns:

this

includeTableAlterOperations

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeTableAlterOperations(IResolvable includeTableAlterOperations)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTableAlterOperations()

Parameters:

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 .

Returns:

this

includeTransactionDetails

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeTransactionDetails(Boolean includeTransactionDetails)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTransactionDetails()

Parameters:

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 .

Returns:

this

includeTransactionDetails

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder includeTransactionDetails(IResolvable includeTransactionDetails)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getIncludeTransactionDetails()

Parameters:

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 .

Returns:

this

messageFormat

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder messageFormat(String messageFormat)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getMessageFormat()

Parameters:

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

Returns:

this

messageMaxBytes

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder messageMaxBytes(Number messageMaxBytes)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getMessageMaxBytes()

Parameters:

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

Returns:

this

noHexPrefix

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder noHexPrefix(Boolean noHexPrefix)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getNoHexPrefix()

Parameters:

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.

Returns:

this

noHexPrefix

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder noHexPrefix(IResolvable noHexPrefix)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getNoHexPrefix()

Parameters:

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.

Returns:

this

partitionIncludeSchemaTable

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getPartitionIncludeSchemaTable()

Parameters:

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 .

Returns:

this

partitionIncludeSchemaTable

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getPartitionIncludeSchemaTable()

Parameters:

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 .

Returns:

this

saslPassword

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder saslPassword(String saslPassword)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSaslPassword()

Parameters:

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.

Returns:

this

saslUserName

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder saslUserName(String saslUserName)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSaslUserName()

Parameters:

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.

Returns:

this

securityProtocol

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder securityProtocol(String securityProtocol)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSecurityProtocol()

Parameters:

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 .

Returns:

this

sslCaCertificateArn

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder sslCaCertificateArn(String sslCaCertificateArn)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslCaCertificateArn()

Parameters:

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.

Returns:

this

sslClientCertificateArn

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder sslClientCertificateArn(String sslClientCertificateArn)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslClientCertificateArn()

Parameters:

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

Returns:

this

sslClientKeyArn

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder sslClientKeyArn(String sslClientKeyArn)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslClientKeyArn()

Parameters:

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

Returns:

this

sslClientKeyPassword

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder sslClientKeyPassword(String sslClientKeyPassword)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getSslClientKeyPassword()

Parameters:

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

Returns:

this

topic

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty.Builder topic(String topic)

Sets the value of CfnEndpoint.KafkaSettingsProperty.getTopic()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnEndpoint.KafkaSettingsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnEndpoint.KafkaSettingsProperty>

Returns:

a new instance of CfnEndpoint.KafkaSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided