You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::DatabaseMigrationService::Types::KafkaSettings

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing KafkaSettings as input to an Aws::Client method, you can use a vanilla Hash:

{
  broker: "String",
  topic: "String",
  message_format: "json", # accepts json, json-unformatted
  include_transaction_details: false,
  include_partition_value: false,
  partition_include_schema_table: false,
  include_table_alter_operations: false,
  include_control_details: false,
  message_max_bytes: 1,
  include_null_and_empty: false,
}

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.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#broker ⇒ String

The broker location and port of the Kafka broker that hosts your Kafka instance. Specify the broker in the form broker-hostname-or-ip:port. For example, "ec2-12-345-678-901.compute-1.amazonaws.com:2345".

Returns:

  • (String) —

    The broker location and port of the Kafka broker that hosts your Kafka instance.

#include_control_details ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#include_null_and_empty ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#include_partition_value ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#include_table_alter_operations ⇒ Boolean

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:

  • (Boolean) —

    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.

#include_transaction_details ⇒ Boolean

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:

  • (Boolean) —

    Provides detailed transaction information from the source database.

#message_format ⇒ String

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

Possible values:

  • json
  • json-unformatted

Returns:

  • (String) —

    The output format for the records created on the endpoint.

#message_max_bytes ⇒ Integer

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

Returns:

  • (Integer) —

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

#partition_include_schema_table ⇒ Boolean

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:

  • (Boolean) —

    Prefixes schema and table names to partition values, when the partition type is primary-key-type.

#topic ⇒ String

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:

  • (String) —

    The topic to which you migrate the data.