Package software.amazon.awscdk.cfnpropertymixins.services.dms

Class CfnEndpointPropsMixin.KafkaSettingsProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.dms.CfnEndpointPropsMixin.KafkaSettingsProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnEndpointPropsMixin.KafkaSettingsProperty

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

A builder for CfnEndpointPropsMixin.KafkaSettingsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeControlDetails(Boolean includeControlDetails)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeControlDetails(IResolvable includeControlDetails)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeNullAndEmpty(Boolean includeNullAndEmpty)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeNullAndEmpty(IResolvable includeNullAndEmpty)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includePartitionValue(Boolean includePartitionValue)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includePartitionValue(IResolvable includePartitionValue)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeTableAlterOperations(Boolean includeTableAlterOperations)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeTableAlterOperations(IResolvable includeTableAlterOperations)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeTransactionDetails(Boolean includeTransactionDetails)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder includeTransactionDetails(IResolvable includeTransactionDetails)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder messageFormat(String messageFormat)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder messageMaxBytes(Number messageMaxBytes)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder noHexPrefix(Boolean noHexPrefix)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder noHexPrefix(IResolvable noHexPrefix)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder partitionIncludeSchemaTable(Boolean partitionIncludeSchemaTable)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder partitionIncludeSchemaTable(IResolvable partitionIncludeSchemaTable)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder saslPassword(String saslPassword)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder saslUserName(String saslUserName)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder securityProtocol(String securityProtocol)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder sslCaCertificateArn(String sslCaCertificateArn)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder sslClientCertificateArn(String sslClientCertificateArn)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder sslClientKeyArn(String sslClientKeyArn)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder sslClientKeyPassword(String sslClientKeyPassword)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty.Builder topic(String topic)

Sets the value of CfnEndpointPropsMixin.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 CfnEndpointPropsMixin.KafkaSettingsProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnEndpointPropsMixin.KafkaSettingsProperty

Throws:

NullPointerException - if any required attribute was not provided