NAME
Paws::DMS::KafkaSettings
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::DMS::KafkaSettings object:
$service_obj->Method(Att1 => { Broker => $value, ..., Topic => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::KafkaSettings object:
$result = $service_obj->Method(...);
$result->Att1->Broker
DESCRIPTION
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.
ATTRIBUTES
Broker => Str
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 AWS Database Migration Service (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html) in the AWS Data Migration Service User Guide.
IncludeControlDetails => Bool
Shows detailed control information for table definition, column definition, and table and column changes in the Kafka message output. The default is false
.
IncludeNullAndEmpty => Bool
Include NULL and empty columns for records migrated to the endpoint. The default is false
.
IncludePartitionValue => Bool
Shows the partition value within the Kafka message output, unless the partition type is schema-table-type
. The default is false
.
IncludeTableAlterOperations => Bool
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
.
IncludeTransactionDetails => Bool
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
.
MessageFormat => Str
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).
MessageMaxBytes => Int
The maximum size in bytes for records created on the endpoint The default is 1,000,000.
PartitionIncludeSchemaTable => Bool
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
.
SaslPassword => Str
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.
SaslUsername => Str
The secure username 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.
SecurityProtocol => Str
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
.
SslCaCertificateArn => Str
The Amazon Resource Name (ARN) for the private Certification Authority (CA) cert that AWS DMS uses to securely connect to your Kafka target endpoint.
SslClientCertificateArn => Str
The Amazon Resource Name (ARN) of the client certificate used to securely connect to a Kafka target endpoint.
SslClientKeyArn => Str
The Amazon Resource Name (ARN) for the client private key used to securely connect to a Kafka target endpoint.
SslClientKeyPassword => Str
The password for the client private key used to securely connect to a Kafka target endpoint.
Topic => Str
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.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::DMS
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues