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

filter: Statementstmt 0.0% 0 / 39 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 41 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::DMS::ModifyEndpoint;
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', required => 1);
11 has EndpointIdentifier => (is => 'ro', isa => 'Str');
12 has EndpointType => (is => 'ro', isa => 'Str');
13 has EngineName => (is => 'ro', isa => 'Str');
14 has ExternalTableDefinition => (is => 'ro', isa => 'Str');
15 has ExtraConnectionAttributes => (is => 'ro', isa => 'Str');
16 has IBMDb2Settings => (is => 'ro', isa => 'Paws::DMS::IBMDb2Settings');
17 has KafkaSettings => (is => 'ro', isa => 'Paws::DMS::KafkaSettings');
18 has KinesisSettings => (is => 'ro', isa => 'Paws::DMS::KinesisSettings');
19 has MicrosoftSQLServerSettings => (is => 'ro', isa => 'Paws::DMS::MicrosoftSQLServerSettings');
20 has MongoDbSettings => (is => 'ro', isa => 'Paws::DMS::MongoDbSettings');
21 has MySQLSettings => (is => 'ro', isa => 'Paws::DMS::MySQLSettings');
22 has NeptuneSettings => (is => 'ro', isa => 'Paws::DMS::NeptuneSettings');
23 has OracleSettings => (is => 'ro', isa => 'Paws::DMS::OracleSettings');
24 has Password => (is => 'ro', isa => 'Str');
25 has Port => (is => 'ro', isa => 'Int');
26 has PostgreSQLSettings => (is => 'ro', isa => 'Paws::DMS::PostgreSQLSettings');
27 has RedshiftSettings => (is => 'ro', isa => 'Paws::DMS::RedshiftSettings');
28 has S3Settings => (is => 'ro', isa => 'Paws::DMS::S3Settings');
29 has ServerName => (is => 'ro', isa => 'Str');
30 has ServiceAccessRoleArn => (is => 'ro', isa => 'Str');
31 has SslMode => (is => 'ro', isa => 'Str');
32 has SybaseSettings => (is => 'ro', isa => 'Paws::DMS::SybaseSettings');
33 has Username => (is => 'ro', isa => 'Str');
34  
35 use MooseX::ClassAttribute;
36  
37 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ModifyEndpoint');
38 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::ModifyEndpointResponse');
39 class_has _result_key => (isa => 'Str', is => 'ro');
40 1;
41  
42 ### main pod documentation begin ###
43  
44 =head1 NAME
45  
46 Paws::DMS::ModifyEndpoint - Arguments for method ModifyEndpoint on L<Paws::DMS>
47  
48 =head1 DESCRIPTION
49  
50 This class represents the parameters used for calling the method ModifyEndpoint on the
51 L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class
52 as arguments to method ModifyEndpoint.
53  
54 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ModifyEndpoint.
55  
56 =head1 SYNOPSIS
57  
58 my $dms = Paws->service('DMS');
59 # Modify endpoint
60 # Modifies the specified endpoint.
61 my $ModifyEndpointResponse = $dms->ModifyEndpoint(
62 'CertificateArn' => '',
63 'DatabaseName' => '',
64 'EndpointArn' => '',
65 'EndpointIdentifier' => '',
66 'EndpointType' => 'source',
67 'EngineName' => '',
68 'ExtraConnectionAttributes' => '',
69 'Password' => '',
70 'Port' => 123,
71 'ServerName' => '',
72 'SslMode' => 'require',
73 'Username' => ''
74 );
75  
76 # Results:
77 my $Endpoint = $ModifyEndpointResponse->Endpoint;
78  
79 # Returns a L<Paws::DMS::ModifyEndpointResponse> object.
80  
81 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
82 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/ModifyEndpoint>
83  
84 =head1 ATTRIBUTES
85  
86  
87 =head2 CertificateArn => Str
88  
89 The Amazon Resource Name (ARN) of the certificate used for SSL
90 connection.
91  
92  
93  
94 =head2 DatabaseName => Str
95  
96 The name of the endpoint database.
97  
98  
99  
100 =head2 DmsTransferSettings => L<Paws::DMS::DmsTransferSettings>
101  
102 The settings in JSON format for the DMS transfer type of source
103 endpoint.
104  
105 Attributes include the following:
106  
107 =over
108  
109 =item *
110  
111 serviceAccessRoleArn - The AWS Identity and Access Management (IAM)
112 role that has permission to access the Amazon S3 bucket.
113  
114 =item *
115  
116 BucketName - The name of the S3 bucket to use.
117  
118 =item *
119  
120 compressionType - An optional parameter to use GZIP to compress the
121 target files. Either set this parameter to NONE (the default) or don't
122 use it to leave the files uncompressed.
123  
124 =back
125  
126 Shorthand syntax for these settings is as follows:
127 C<ServiceAccessRoleArn=string
128 ,BucketName=string,CompressionType=string>
129  
130 JSON syntax for these settings is as follows: C<{
131 "ServiceAccessRoleArn": "string", "BucketName": "string",
132 "CompressionType": "none"|"gzip" }>
133  
134  
135  
136 =head2 DocDbSettings => L<Paws::DMS::DocDbSettings>
137  
138 Settings in JSON format for the source DocumentDB endpoint. For more
139 information about the available settings, see the configuration
140 properties section in Using DocumentDB as a Target for AWS Database
141 Migration Service
142 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DocumentDB.html)
143 in the I<AWS Database Migration Service User Guide.>
144  
145  
146  
147 =head2 DynamoDbSettings => L<Paws::DMS::DynamoDbSettings>
148  
149 Settings in JSON format for the target Amazon DynamoDB endpoint. For
150 information about other available settings, see Using Object Mapping to
151 Migrate Data to DynamoDB
152 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html)
153 in the I<AWS Database Migration Service User Guide.>
154  
155  
156  
157 =head2 ElasticsearchSettings => L<Paws::DMS::ElasticsearchSettings>
158  
159 Settings in JSON format for the target Elasticsearch endpoint. For more
160 information about the available settings, see Extra Connection
161 Attributes When Using Elasticsearch as a Target for AWS DMS
162 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Elasticsearch.html#CHAP_Target.Elasticsearch.Configuration)
163 in the I<AWS Database Migration Service User Guide.>
164  
165  
166  
167 =head2 B<REQUIRED> EndpointArn => Str
168  
169 The Amazon Resource Name (ARN) string that uniquely identifies the
170 endpoint.
171  
172  
173  
174 =head2 EndpointIdentifier => Str
175  
176 The database endpoint identifier. Identifiers must begin with a letter
177 and must contain only ASCII letters, digits, and hyphens. They can't
178 end with a hyphen or contain two consecutive hyphens.
179  
180  
181  
182 =head2 EndpointType => Str
183  
184 The type of endpoint. Valid values are C<source> and C<target>.
185  
186 Valid values are: C<"source">, C<"target">
187  
188 =head2 EngineName => Str
189  
190 The type of engine for the endpoint. Valid values, depending on the
191 EndpointType, include C<"mysql">, C<"oracle">, C<"postgres">,
192 C<"mariadb">, C<"aurora">, C<"aurora-postgresql">, C<"redshift">,
193 C<"s3">, C<"db2">, C<"azuredb">, C<"sybase">, C<"dynamodb">,
194 C<"mongodb">, C<"kinesis">, C<"kafka">, C<"elasticsearch">,
195 C<"documentdb">, C<"sqlserver">, and C<"neptune">.
196  
197  
198  
199 =head2 ExternalTableDefinition => Str
200  
201 The external table definition.
202  
203  
204  
205 =head2 ExtraConnectionAttributes => Str
206  
207 Additional attributes associated with the connection. To reset this
208 parameter, pass the empty string ("") as an argument.
209  
210  
211  
212 =head2 IBMDb2Settings => L<Paws::DMS::IBMDb2Settings>
213  
214 Settings in JSON format for the source IBM Db2 LUW endpoint. For
215 information about other available settings, see Extra connection
216 attributes when using Db2 LUW as a source for AWS DMS
217 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.DB2.ConnectionAttrib)
218 in the I<AWS Database Migration Service User Guide.>
219  
220  
221  
222 =head2 KafkaSettings => L<Paws::DMS::KafkaSettings>
223  
224 Settings in JSON format for the target Apache Kafka endpoint. For more
225 information about the available settings, see Using Apache Kafka as a
226 Target for AWS Database Migration Service
227 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kafka.html)
228 in the I<AWS Database Migration Service User Guide.>
229  
230  
231  
232 =head2 KinesisSettings => L<Paws::DMS::KinesisSettings>
233  
234 Settings in JSON format for the target endpoint for Amazon Kinesis Data
235 Streams. For more information about the available settings, see Using
236 Amazon Kinesis Data Streams as a Target for AWS Database Migration
237 Service
238 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Kinesis.html)
239 in the I<AWS Database Migration Service User Guide.>
240  
241  
242  
243 =head2 MicrosoftSQLServerSettings => L<Paws::DMS::MicrosoftSQLServerSettings>
244  
245 Settings in JSON format for the source and target Microsoft SQL Server
246 endpoint. For information about other available settings, see Extra
247 connection attributes when using SQL Server as a source for AWS DMS
248 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SQLServer.ConnectionAttrib)
249 and Extra connection attributes when using SQL Server as a target for
250 AWS DMS
251 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SQLServer.ConnectionAttrib)
252 in the I<AWS Database Migration Service User Guide.>
253  
254  
255  
256 =head2 MongoDbSettings => L<Paws::DMS::MongoDbSettings>
257  
258 Settings in JSON format for the source MongoDB endpoint. For more
259 information about the available settings, see the configuration
260 properties section in Using MongoDB as a Target for AWS Database
261 Migration Service
262 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html)
263 in the I<AWS Database Migration Service User Guide.>
264  
265  
266  
267 =head2 MySQLSettings => L<Paws::DMS::MySQLSettings>
268  
269 Settings in JSON format for the source and target MySQL endpoint. For
270 information about other available settings, see Extra connection
271 attributes when using MySQL as a source for AWS DMS
272 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MySQL.ConnectionAttrib)
273 and Extra connection attributes when using a MySQL-compatible database
274 as a target for AWS DMS
275 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.MySQL.ConnectionAttrib)
276 in the I<AWS Database Migration Service User Guide.>
277  
278  
279  
280 =head2 NeptuneSettings => L<Paws::DMS::NeptuneSettings>
281  
282 Settings in JSON format for the target Amazon Neptune endpoint. For
283 more information about the available settings, see Specifying Endpoint
284 Settings for Amazon Neptune as a Target
285 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings)
286 in the I<AWS Database Migration Service User Guide.>
287  
288  
289  
290 =head2 OracleSettings => L<Paws::DMS::OracleSettings>
291  
292 Settings in JSON format for the source and target Oracle endpoint. For
293 information about other available settings, see Extra connection
294 attributes when using Oracle as a source for AWS DMS
295 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.ConnectionAttrib)
296 and Extra connection attributes when using Oracle as a target for AWS
297 DMS
298 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Oracle.ConnectionAttrib)
299 in the I<AWS Database Migration Service User Guide.>
300  
301  
302  
303 =head2 Password => Str
304  
305 The password to be used to login to the endpoint database.
306  
307  
308  
309 =head2 Port => Int
310  
311 The port used by the endpoint database.
312  
313  
314  
315 =head2 PostgreSQLSettings => L<Paws::DMS::PostgreSQLSettings>
316  
317 Settings in JSON format for the source and target PostgreSQL endpoint.
318 For information about other available settings, see Extra connection
319 attributes when using PostgreSQL as a source for AWS DMS
320 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.ConnectionAttrib)
321 and Extra connection attributes when using PostgreSQL as a target for
322 AWS DMS
323 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.PostgreSQL.ConnectionAttrib)
324 in the I<AWS Database Migration Service User Guide.>
325  
326  
327  
328 =head2 RedshiftSettings => L<Paws::DMS::RedshiftSettings>
329  
330  
331  
332  
333  
334 =head2 S3Settings => L<Paws::DMS::S3Settings>
335  
336 Settings in JSON format for the target Amazon S3 endpoint. For more
337 information about the available settings, see Extra Connection
338 Attributes When Using Amazon S3 as a Target for AWS DMS
339 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html#CHAP_Target.S3.Configuring)
340 in the I<AWS Database Migration Service User Guide.>
341  
342  
343  
344 =head2 ServerName => Str
345  
346 The name of the server where the endpoint database resides.
347  
348  
349  
350 =head2 ServiceAccessRoleArn => Str
351  
352 The Amazon Resource Name (ARN) for the service access role you want to
353 use to modify the endpoint.
354  
355  
356  
357 =head2 SslMode => Str
358  
359 The SSL mode used to connect to the endpoint. The default value is
360 C<none>.
361  
362 Valid values are: C<"none">, C<"require">, C<"verify-ca">, C<"verify-full">
363  
364 =head2 SybaseSettings => L<Paws::DMS::SybaseSettings>
365  
366 Settings in JSON format for the source and target SAP ASE endpoint. For
367 information about other available settings, see Extra connection
368 attributes when using SAP ASE as a source for AWS DMS
369 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.SAP.ConnectionAttrib)
370 and Extra connection attributes when using SAP ASE as a target for AWS
371 DMS
372 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.SAP.ConnectionAttrib)
373 in the I<AWS Database Migration Service User Guide.>
374  
375  
376  
377 =head2 Username => Str
378  
379 The user name to be used to login to the endpoint database.
380  
381  
382  
383  
384 =head1 SEE ALSO
385  
386 This class forms part of L<Paws>, documenting arguments for method ModifyEndpoint in L<Paws::DMS>
387  
388 =head1 BUGS and CONTRIBUTIONS
389  
390 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
391  
392 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
393  
394 =cut
395