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,
  security_protocol: "plaintext", # accepts plaintext, ssl-authentication, ssl-encryption, sasl-ssl
  ssl_client_certificate_arn: "String",
  ssl_client_key_arn: "String",
  ssl_client_key_password: "SecretString",
  ssl_ca_certificate_arn: "String",
  sasl_username: "String",
  sasl_password: "SecretString",
  no_hex_prefix: 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 =
[:ssl_client_key_password, :sasl_password]

Instance Attribute Summary collapse

Instance Attribute Details

#brokerString

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:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#no_hex_prefixBoolean

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:

  • (Boolean)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  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)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#sasl_passwordString

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:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#sasl_usernameString

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:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#security_protocolString

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:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_ca_certificate_arnString

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

Returns:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_client_certificate_arnString

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

Returns:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_client_key_arnString

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

Returns:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_client_key_passwordString

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

Returns:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#topicString

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:

  • (String)


4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-databasemigrationservice/lib/aws-sdk-databasemigrationservice/types.rb', line 4330

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,
  :security_protocol,
  :ssl_client_certificate_arn,
  :ssl_client_key_arn,
  :ssl_client_key_password,
  :ssl_ca_certificate_arn,
  :sasl_username,
  :sasl_password,
  :no_hex_prefix)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end