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

filter: Statementstmt 0.0% 0 / 36 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 37 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::Endpoint;
3 use Moose;
4 has CertificateArn => (is => 'ro', isa => 'Str');
5 has DatabaseName => (is => 'ro', isa => 'Str');
6 has DmsTransferSettings => (is => 'ro', isa => 'Paws::DMS::DmsTransferSettings');
7 has DocDbSettings => (is => 'ro', isa => 'Paws::DMS::DocDbSettings');
8 has DynamoDbSettings => (is => 'ro', isa => 'Paws::DMS::DynamoDbSettings');
9 has ElasticsearchSettings => (is => 'ro', isa => 'Paws::DMS::ElasticsearchSettings');
10 has EndpointArn => (is => 'ro', isa => 'Str');
11 has EndpointIdentifier => (is => 'ro', isa => 'Str');
12 has EndpointType => (is => 'ro', isa => 'Str');
13 has EngineDisplayName => (is => 'ro', isa => 'Str');
14 has EngineName => (is => 'ro', isa => 'Str');
15 has ExternalId => (is => 'ro', isa => 'Str');
16 has ExternalTableDefinition => (is => 'ro', isa => 'Str');
17 has ExtraConnectionAttributes => (is => 'ro', isa => 'Str');
18 has IBMDb2Settings => (is => 'ro', isa => 'Paws::DMS::IBMDb2Settings');
19 has KafkaSettings => (is => 'ro', isa => 'Paws::DMS::KafkaSettings');
20 has KinesisSettings => (is => 'ro', isa => 'Paws::DMS::KinesisSettings');
21 has KmsKeyId => (is => 'ro', isa => 'Str');
22 has MicrosoftSQLServerSettings => (is => 'ro', isa => 'Paws::DMS::MicrosoftSQLServerSettings');
23 has MongoDbSettings => (is => 'ro', isa => 'Paws::DMS::MongoDbSettings');
24 has MySQLSettings => (is => 'ro', isa => 'Paws::DMS::MySQLSettings');
25 has NeptuneSettings => (is => 'ro', isa => 'Paws::DMS::NeptuneSettings');
26 has OracleSettings => (is => 'ro', isa => 'Paws::DMS::OracleSettings');
27 has Port => (is => 'ro', isa => 'Int');
28 has PostgreSQLSettings => (is => 'ro', isa => 'Paws::DMS::PostgreSQLSettings');
29 has RedshiftSettings => (is => 'ro', isa => 'Paws::DMS::RedshiftSettings');
30 has S3Settings => (is => 'ro', isa => 'Paws::DMS::S3Settings');
31 has ServerName => (is => 'ro', isa => 'Str');
32 has ServiceAccessRoleArn => (is => 'ro', isa => 'Str');
33 has SslMode => (is => 'ro', isa => 'Str');
34 has Status => (is => 'ro', isa => 'Str');
35 has SybaseSettings => (is => 'ro', isa => 'Paws::DMS::SybaseSettings');
36 has Username => (is => 'ro', isa => 'Str');
37  
38 1;
39  
40 ### main pod documentation begin ###
41  
42 =head1 NAME
43  
44 Paws::DMS::Endpoint
45  
46 =head1 USAGE
47  
48 This class represents one of two things:
49  
50 =head3 Arguments in a call to a service
51  
52 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
53 Each attribute should be used as a named argument in the calls that expect this type of object.
54  
55 As an example, if Att1 is expected to be a Paws::DMS::Endpoint object:
56  
57 $service_obj->Method(Att1 => { CertificateArn => $value, ..., Username => $value });
58  
59 =head3 Results returned from an API call
60  
61 Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::Endpoint object:
62  
63 $result = $service_obj->Method(...);
64 $result->Att1->CertificateArn
65  
66 =head1 DESCRIPTION
67  
68 Describes an endpoint of a database instance in response to operations
69 such as the following:
70  
71 =over
72  
73 =item *
74  
75 C<CreateEndpoint>
76  
77 =item *
78  
79 C<DescribeEndpoint>
80  
81 =item *
82  
83 C<DescribeEndpointTypes>
84  
85 =item *
86  
87 C<ModifyEndpoint>
88  
89 =back
90  
91  
92 =head1 ATTRIBUTES
93  
94  
95 =head2 CertificateArn => Str
96  
97 The Amazon Resource Name (ARN) used for SSL connection to the endpoint.
98  
99  
100 =head2 DatabaseName => Str
101  
102 The name of the database at the endpoint.
103  
104  
105 =head2 DmsTransferSettings => L<Paws::DMS::DmsTransferSettings>
106  
107 The settings in JSON format for the DMS transfer type of source
108 endpoint.
109  
110 Possible settings include the following:
111  
112 =over
113  
114 =item *
115  
116 C<ServiceAccessRoleArn> - The IAM role that has permission to access
117 the Amazon S3 bucket.
118  
119 =item *
120  
121 C<BucketName> - The name of the S3 bucket to use.
122  
123 =item *
124  
125 C<CompressionType> - An optional parameter to use GZIP to compress the
126 target files. To use GZIP, set this value to C<NONE> (the default). To
127 keep the files uncompressed, don't use this value.
128  
129 =back
130  
131 Shorthand syntax for these settings is as follows:
132 C<ServiceAccessRoleArn=string,BucketName=string,CompressionType=string>
133  
134 JSON syntax for these settings is as follows: C<{
135 "ServiceAccessRoleArn": "string", "BucketName": "string",
136 "CompressionType": "none"|"gzip" }>
137  
138  
139 =head2 DocDbSettings => L<Paws::DMS::DocDbSettings>
140  
141  
142  
143  
144 =head2 DynamoDbSettings => L<Paws::DMS::DynamoDbSettings>
145  
146 The settings for the DynamoDB target endpoint. For more information,
147 see the C<DynamoDBSettings> structure.
148  
149  
150 =head2 ElasticsearchSettings => L<Paws::DMS::ElasticsearchSettings>
151  
152 The settings for the Elasticsearch source endpoint. For more
153 information, see the C<ElasticsearchSettings> structure.
154  
155  
156 =head2 EndpointArn => Str
157  
158 The Amazon Resource Name (ARN) string that uniquely identifies the
159 endpoint.
160  
161  
162 =head2 EndpointIdentifier => Str
163  
164 The database endpoint identifier. Identifiers must begin with a letter
165 and must contain only ASCII letters, digits, and hyphens. They can't
166 end with a hyphen or contain two consecutive hyphens.
167  
168  
169 =head2 EndpointType => Str
170  
171 The type of endpoint. Valid values are C<source> and C<target>.
172  
173  
174 =head2 EngineDisplayName => Str
175  
176 The expanded name for the engine name. For example, if the
177 C<EngineName> parameter is "aurora," this value would be "Amazon Aurora
178 MySQL."
179  
180  
181 =head2 EngineName => Str
182  
183 The database engine name. Valid values, depending on the EndpointType,
184 include C<"mysql">, C<"oracle">, C<"postgres">, C<"mariadb">,
185 C<"aurora">, C<"aurora-postgresql">, C<"redshift">, C<"s3">, C<"db2">,
186 C<"azuredb">, C<"sybase">, C<"dynamodb">, C<"mongodb">, C<"kinesis">,
187 C<"kafka">, C<"elasticsearch">, C<"documentdb">, C<"sqlserver">, and
188 C<"neptune">.
189  
190  
191 =head2 ExternalId => Str
192  
193 Value returned by a call to CreateEndpoint that can be used for
194 cross-account validation. Use it on a subsequent call to CreateEndpoint
195 to create the endpoint with a cross-account.
196  
197  
198 =head2 ExternalTableDefinition => Str
199  
200 The external table definition.
201  
202  
203 =head2 ExtraConnectionAttributes => Str
204  
205 Additional connection attributes used to connect to the endpoint.
206  
207  
208 =head2 IBMDb2Settings => L<Paws::DMS::IBMDb2Settings>
209  
210 The settings for the IBM Db2 LUW source endpoint. For more information,
211 see the C<IBMDb2Settings> structure.
212  
213  
214 =head2 KafkaSettings => L<Paws::DMS::KafkaSettings>
215  
216 The settings for the Apache Kafka target endpoint. For more
217 information, see the C<KafkaSettings> structure.
218  
219  
220 =head2 KinesisSettings => L<Paws::DMS::KinesisSettings>
221  
222 The settings for the Amazon Kinesis target endpoint. For more
223 information, see the C<KinesisSettings> structure.
224  
225  
226 =head2 KmsKeyId => Str
227  
228 An AWS KMS key identifier that is used to encrypt the connection
229 parameters for the endpoint.
230  
231 If you don't specify a value for the C<KmsKeyId> parameter, then AWS
232 DMS uses your default encryption key.
233  
234 AWS KMS creates the default encryption key for your AWS account. Your
235 AWS account has a different default encryption key for each AWS Region.
236  
237  
238 =head2 MicrosoftSQLServerSettings => L<Paws::DMS::MicrosoftSQLServerSettings>
239  
240 The settings for the Microsoft SQL Server source and target endpoint.
241 For more information, see the C<MicrosoftSQLServerSettings> structure.
242  
243  
244 =head2 MongoDbSettings => L<Paws::DMS::MongoDbSettings>
245  
246 The settings for the MongoDB source endpoint. For more information, see
247 the C<MongoDbSettings> structure.
248  
249  
250 =head2 MySQLSettings => L<Paws::DMS::MySQLSettings>
251  
252 The settings for the MySQL source and target endpoint. For more
253 information, see the C<MySQLSettings> structure.
254  
255  
256 =head2 NeptuneSettings => L<Paws::DMS::NeptuneSettings>
257  
258 The settings for the Amazon Neptune target endpoint. For more
259 information, see the C<NeptuneSettings> structure.
260  
261  
262 =head2 OracleSettings => L<Paws::DMS::OracleSettings>
263  
264 The settings for the Oracle source and target endpoint. For more
265 information, see the C<OracleSettings> structure.
266  
267  
268 =head2 Port => Int
269  
270 The port value used to access the endpoint.
271  
272  
273 =head2 PostgreSQLSettings => L<Paws::DMS::PostgreSQLSettings>
274  
275 The settings for the PostgreSQL source and target endpoint. For more
276 information, see the C<PostgreSQLSettings> structure.
277  
278  
279 =head2 RedshiftSettings => L<Paws::DMS::RedshiftSettings>
280  
281 Settings for the Amazon Redshift endpoint.
282  
283  
284 =head2 S3Settings => L<Paws::DMS::S3Settings>
285  
286 The settings for the S3 target endpoint. For more information, see the
287 C<S3Settings> structure.
288  
289  
290 =head2 ServerName => Str
291  
292 The name of the server at the endpoint.
293  
294  
295 =head2 ServiceAccessRoleArn => Str
296  
297 The Amazon Resource Name (ARN) used by the service access IAM role.
298  
299  
300 =head2 SslMode => Str
301  
302 The SSL mode used to connect to the endpoint. The default value is
303 C<none>.
304  
305  
306 =head2 Status => Str
307  
308 The status of the endpoint.
309  
310  
311 =head2 SybaseSettings => L<Paws::DMS::SybaseSettings>
312  
313 The settings for the SAP ASE source and target endpoint. For more
314 information, see the C<SybaseSettings> structure.
315  
316  
317 =head2 Username => Str
318  
319 The user name used to connect to the endpoint.
320  
321  
322  
323 =head1 SEE ALSO
324  
325 This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
326  
327 =head1 BUGS and CONTRIBUTIONS
328  
329 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
330  
331 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
332  
333 =cut
334