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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb

Overview

Note:

When making an API call, you may pass KafkaSettings data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#brokerString

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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#include_control_detailsBoolean

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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#include_null_and_emptyBoolean

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

Returns:

  • (Boolean)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#include_partition_valueBoolean

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

Returns:

  • (Boolean)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#include_table_alter_operationsBoolean

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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#include_transaction_detailsBoolean

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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#message_formatString

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:

  • (String)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#message_max_bytesInteger

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

Returns:

  • (Integer)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#partition_include_schema_tableBoolean

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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end

#topicString

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)


4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4011

class KafkaSettings < Struct.new(
  :broker,
  :topic,
  :message_format,
  :include_transaction_details,
  :include_partition_value,
  :partition_include_schema_table,
  :include_table_alter_operations,
  :include_control_details,
  :message_max_bytes,
  :include_null_and_empty)
  SENSITIVE = []
  include Aws::Structure
end