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

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

Overview

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.

See Also:

Constant Summary collapse

SENSITIVE = 
[:ssl_client_key_password, :sasl_password]

Instance Attribute Summary collapse

Instance Attribute Details

#broker ⇒ String

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

[1]: docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

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


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#include_null_and_empty ⇒ Boolean

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

Returns:

  • (Boolean) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

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


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

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


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

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


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

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

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#message_max_bytes ⇒ Integer

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

Returns:

  • (Integer) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#no_hex_prefix ⇒ Boolean

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) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

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


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#sasl_mechanism ⇒ String

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:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#sasl_password ⇒ String

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) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#sasl_username ⇒ String

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) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#security_protocol ⇒ String

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) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_ca_certificate_arn ⇒ String

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) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_client_certificate_arn ⇒ String

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

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_client_key_arn ⇒ String

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

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_client_key_password ⇒ String

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

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#ssl_endpoint_identification_algorithm ⇒ String

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

Returns:

  • (String) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end

#topic ⇒ String

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) 


6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
 
# File 'lib/aws-sdk-databasemigrationservice/types.rb', line 6401

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,
  :sasl_mechanism,
  :ssl_endpoint_identification_algorithm)
  SENSITIVE = [:ssl_client_key_password, :sasl_password]
  include Aws::Structure
end