Package software.amazon.awssdk.services.databasemigration.model

Interface KafkaSettings.Builder

    • Method Detail

      • broker

        KafkaSettings.Builder broker​(String 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 Database Migration Service in the Database Migration Service User Guide.

        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 Database Migration Service in the Database Migration Service User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • topic

        KafkaSettings.Builder topic​(String topic)

        The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.

        Parameters:
        topic - The topic to which you migrate the data. If you don't specify a topic, DMS specifies "kafka-default-topic" as the migration topic.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageFormat

        KafkaSettings.Builder messageFormat​(String 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).

        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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageFormatValue, MessageFormatValue

      • messageFormat

        KafkaSettings.Builder messageFormat​(MessageFormatValue 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).

        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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageFormatValue, MessageFormatValue

      • includeTransactionDetails

        KafkaSettings.Builder includeTransactionDetails​(Boolean 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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • includePartitionValue

        KafkaSettings.Builder includePartitionValue​(Boolean includePartitionValue)

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

        Parameters:
        includePartitionValue - Shows the partition value within the Kafka message output unless the partition type is schema-table-type. The default is false.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • partitionIncludeSchemaTable

        KafkaSettings.Builder partitionIncludeSchemaTable​(Boolean 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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • includeTableAlterOperations

        KafkaSettings.Builder includeTableAlterOperations​(Boolean 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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • includeControlDetails

        KafkaSettings.Builder includeControlDetails​(Boolean includeControlDetails)

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

        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:
        Returns a reference to this object so that method calls can be chained together.

      • messageMaxBytes

        KafkaSettings.Builder messageMaxBytes​(Integer messageMaxBytes)

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

        Parameters:
        messageMaxBytes - The maximum size in bytes for records created on the endpoint The default is 1,000,000.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeNullAndEmpty

        KafkaSettings.Builder includeNullAndEmpty​(Boolean includeNullAndEmpty)

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

        Parameters:
        includeNullAndEmpty - Include NULL and empty columns for records migrated to the endpoint. The default is false .
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • securityProtocol

        KafkaSettings.Builder securityProtocol​(String 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.

        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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KafkaSecurityProtocol, KafkaSecurityProtocol

      • securityProtocol

        KafkaSettings.Builder securityProtocol​(KafkaSecurityProtocol 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.

        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:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KafkaSecurityProtocol, KafkaSecurityProtocol

      • sslClientCertificateArn

        KafkaSettings.Builder sslClientCertificateArn​(String sslClientCertificateArn)

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

        Parameters:
        sslClientCertificateArn - The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sslClientKeyArn

        KafkaSettings.Builder sslClientKeyArn​(String sslClientKeyArn)

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

        Parameters:
        sslClientKeyArn - The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sslClientKeyPassword

        KafkaSettings.Builder sslClientKeyPassword​(String sslClientKeyPassword)

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

        Parameters:
        sslClientKeyPassword - The password for the client private key used to securely connect to a Kafka target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sslCaCertificateArn

        KafkaSettings.Builder sslCaCertificateArn​(String sslCaCertificateArn)

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

        Parameters:
        sslCaCertificateArn - The Amazon Resource Name (ARN) for the private certificate authority (CA) cert that DMS uses to securely connect to your Kafka target endpoint.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • saslUsername

        KafkaSettings.Builder saslUsername​(String saslUsername)

        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.

        Parameters:
        saslUsername - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • saslPassword

        KafkaSettings.Builder saslPassword​(String saslPassword)

        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.

        Parameters:
        saslPassword - 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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • noHexPrefix

        KafkaSettings.Builder noHexPrefix​(Boolean noHexPrefix)

        Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, 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.

        Parameters:
        noHexPrefix - Set this optional parameter to true to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, 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:
        Returns a reference to this object so that method calls can be chained together.

      • saslMechanism

        KafkaSettings.Builder saslMechanism​(String saslMechanism)

        For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.

        Parameters:
        saslMechanism - For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KafkaSaslMechanism, KafkaSaslMechanism

      • saslMechanism

        KafkaSettings.Builder saslMechanism​(KafkaSaslMechanism saslMechanism)

        For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.

        Parameters:
        saslMechanism - For SASL/SSL authentication, DMS supports the SCRAM-SHA-512 mechanism by default. DMS versions 3.5.0 and later also support the PLAIN mechanism. To use the PLAIN mechanism, set this parameter to PLAIN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KafkaSaslMechanism, KafkaSaslMechanism

      • sslEndpointIdentificationAlgorithm

        KafkaSettings.Builder sslEndpointIdentificationAlgorithm​(String sslEndpointIdentificationAlgorithm)

        Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.

        Parameters:
        sslEndpointIdentificationAlgorithm - Sets hostname verification for the certificate. This setting is supported in DMS version 3.5.1 and later.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        KafkaSslEndpointIdentificationAlgorithm, KafkaSslEndpointIdentificationAlgorithm

      • useLargeIntegerValue

        KafkaSettings.Builder useLargeIntegerValue​(Boolean useLargeIntegerValue)

        Specifies using the large integer value with Kafka.

        Parameters:
        useLargeIntegerValue - Specifies using the large integer value with Kafka.
        Returns:
        Returns a reference to this object so that method calls can be chained together.