blib/lib/Paws/DMS/KafkaSettings.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::DMS::KafkaSettings;
3 use Moose;
4 has Broker => (is => 'ro', isa => 'Str');
5 has IncludeControlDetails => (is => 'ro', isa => 'Bool');
6 has IncludeNullAndEmpty => (is => 'ro', isa => 'Bool');
7 has IncludePartitionValue => (is => 'ro', isa => 'Bool');
8 has IncludeTableAlterOperations => (is => 'ro', isa => 'Bool');
9 has IncludeTransactionDetails => (is => 'ro', isa => 'Bool');
10 has MessageFormat => (is => 'ro', isa => 'Str');
11 has MessageMaxBytes => (is => 'ro', isa => 'Int');
12 has PartitionIncludeSchemaTable => (is => 'ro', isa => 'Bool');
13 has SaslPassword => (is => 'ro', isa => 'Str');
14 has SaslUsername => (is => 'ro', isa => 'Str');
15 has SecurityProtocol => (is => 'ro', isa => 'Str');
16 has SslCaCertificateArn => (is => 'ro', isa => 'Str');
17 has SslClientCertificateArn => (is => 'ro', isa => 'Str');
18 has SslClientKeyArn => (is => 'ro', isa => 'Str');
19 has SslClientKeyPassword => (is => 'ro', isa => 'Str');
20 has Topic => (is => 'ro', isa => 'Str');
21  
22 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::DMS::KafkaSettings
29  
30 =head1 USAGE
31  
32 This class represents one of two things:
33  
34 =head3 Arguments in a call to a service
35  
36 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
37 Each attribute should be used as a named argument in the calls that expect this type of object.
38  
39 As an example, if Att1 is expected to be a Paws::DMS::KafkaSettings object:
40  
41 $service_obj->Method(Att1 => { Broker => $value, ..., Topic => $value });
42  
43 =head3 Results returned from an API call
44  
45 Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::KafkaSettings object:
46  
47 $result = $service_obj->Method(...);
48 $result->Att1->Broker
49  
50 =head1 DESCRIPTION
51  
52 Provides information that describes an Apache Kafka endpoint. This
53 information includes the output format of records applied to the
54 endpoint and details of transaction and control table data information.
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 Broker => Str
60  
61 A comma-separated list of one or more broker locations in your Kafka
62 cluster that host your Kafka instance. Specify each broker location in
63 the form C< I<broker-hostname-or-ip>:I<port> >. For example,
64 C<"ec2-12-345-678-901.compute-1.amazonaws.com:2345">. For more
65 information and examples of specifying a list of broker locations, see
66 Using Apache Kafka as a target for AWS Database Migration Service
67 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html)
68 in the I<AWS Data Migration Service User Guide>.
69  
70  
71 =head2 IncludeControlDetails => Bool
72  
73 Shows detailed control information for table definition, column
74 definition, and table and column changes in the Kafka message output.
75 The default is C<false>.
76  
77  
78 =head2 IncludeNullAndEmpty => Bool
79  
80 Include NULL and empty columns for records migrated to the endpoint.
81 The default is C<false>.
82  
83  
84 =head2 IncludePartitionValue => Bool
85  
86 Shows the partition value within the Kafka message output, unless the
87 partition type is C<schema-table-type>. The default is C<false>.
88  
89  
90 =head2 IncludeTableAlterOperations => Bool
91  
92 Includes any data definition language (DDL) operations that change the
93 table in the control data, such as C<rename-table>, C<drop-table>,
94 C<add-column>, C<drop-column>, and C<rename-column>. The default is
95 C<false>.
96  
97  
98 =head2 IncludeTransactionDetails => Bool
99  
100 Provides detailed transaction information from the source database.
101 This information includes a commit timestamp, a log position, and
102 values for C<transaction_id>, previous C<transaction_id>, and
103 C<transaction_record_id> (the record offset within a transaction). The
104 default is C<false>.
105  
106  
107 =head2 MessageFormat => Str
108  
109 The output format for the records created on the endpoint. The message
110 format is C<JSON> (default) or C<JSON_UNFORMATTED> (a single line with
111 no tab).
112  
113  
114 =head2 MessageMaxBytes => Int
115  
116 The maximum size in bytes for records created on the endpoint The
117 default is 1,000,000.
118  
119  
120 =head2 PartitionIncludeSchemaTable => Bool
121  
122 Prefixes schema and table names to partition values, when the partition
123 type is C<primary-key-type>. Doing this increases data distribution
124 among Kafka partitions. For example, suppose that a SysBench schema has
125 thousands of tables and each table has only limited range for a primary
126 key. In this case, the same primary key is sent from thousands of
127 tables to the same partition, which causes throttling. The default is
128 C<false>.
129  
130  
131 =head2 SaslPassword => Str
132  
133 The secure password you created when you first set up your MSK cluster
134 to validate a client identity and make an encrypted connection between
135 server and client using SASL-SSL authentication.
136  
137  
138 =head2 SaslUsername => Str
139  
140 The secure username you created when you first set up your MSK cluster
141 to validate a client identity and make an encrypted connection between
142 server and client using SASL-SSL authentication.
143  
144  
145 =head2 SecurityProtocol => Str
146  
147 Set secure connection to a Kafka target endpoint using Transport Layer
148 Security (TLS). Options include C<ssl-encryption>,
149 C<ssl-authentication>, and C<sasl-ssl>. C<sasl-ssl> requires
150 C<SaslUsername> and C<SaslPassword>.
151  
152  
153 =head2 SslCaCertificateArn => Str
154  
155 The Amazon Resource Name (ARN) for the private Certification Authority
156 (CA) cert that AWS DMS uses to securely connect to your Kafka target
157 endpoint.
158  
159  
160 =head2 SslClientCertificateArn => Str
161  
162 The Amazon Resource Name (ARN) of the client certificate used to
163 securely connect to a Kafka target endpoint.
164  
165  
166 =head2 SslClientKeyArn => Str
167  
168 The Amazon Resource Name (ARN) for the client private key used to
169 securely connect to a Kafka target endpoint.
170  
171  
172 =head2 SslClientKeyPassword => Str
173  
174 The password for the client private key used to securely connect to a
175 Kafka target endpoint.
176  
177  
178 =head2 Topic => Str
179  
180 The topic to which you migrate the data. If you don't specify a topic,
181 AWS DMS specifies C<"kafka-default-topic"> as the migration topic.
182  
183  
184  
185 =head1 SEE ALSO
186  
187 This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
188  
189 =head1 BUGS and CONTRIBUTIONS
190  
191 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
192  
193 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
194  
195 =cut
196