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

filter: Statementstmt 0.0% 0 / 38 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 39 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::OracleSettings;
3 use Moose;
4 has AccessAlternateDirectly => (is => 'ro', isa => 'Bool');
5 has AdditionalArchivedLogDestId => (is => 'ro', isa => 'Int');
6 has AddSupplementalLogging => (is => 'ro', isa => 'Bool');
7 has AllowSelectNestedTables => (is => 'ro', isa => 'Bool');
8 has ArchivedLogDestId => (is => 'ro', isa => 'Int');
9 has ArchivedLogsOnly => (is => 'ro', isa => 'Bool');
10 has AsmPassword => (is => 'ro', isa => 'Str');
11 has AsmServer => (is => 'ro', isa => 'Str');
12 has AsmUser => (is => 'ro', isa => 'Str');
13 has CharLengthSemantics => (is => 'ro', isa => 'Str');
14 has DatabaseName => (is => 'ro', isa => 'Str');
15 has DirectPathNoLog => (is => 'ro', isa => 'Bool');
16 has DirectPathParallelLoad => (is => 'ro', isa => 'Bool');
17 has EnableHomogenousTablespace => (is => 'ro', isa => 'Bool');
18 has FailTasksOnLobTruncation => (is => 'ro', isa => 'Bool');
19 has NumberDatatypeScale => (is => 'ro', isa => 'Int');
20 has OraclePathPrefix => (is => 'ro', isa => 'Str');
21 has ParallelAsmReadThreads => (is => 'ro', isa => 'Int');
22 has Password => (is => 'ro', isa => 'Str');
23 has Port => (is => 'ro', isa => 'Int');
24 has ReadAheadBlocks => (is => 'ro', isa => 'Int');
25 has ReadTableSpaceName => (is => 'ro', isa => 'Bool');
26 has ReplacePathPrefix => (is => 'ro', isa => 'Bool');
27 has RetryInterval => (is => 'ro', isa => 'Int');
28 has SecretsManagerAccessRoleArn => (is => 'ro', isa => 'Str');
29 has SecretsManagerOracleAsmAccessRoleArn => (is => 'ro', isa => 'Str');
30 has SecretsManagerOracleAsmSecretId => (is => 'ro', isa => 'Str');
31 has SecretsManagerSecretId => (is => 'ro', isa => 'Str');
32 has SecurityDbEncryption => (is => 'ro', isa => 'Str');
33 has SecurityDbEncryptionName => (is => 'ro', isa => 'Str');
34 has ServerName => (is => 'ro', isa => 'Str');
35 has SpatialDataOptionToGeoJsonFunctionName => (is => 'ro', isa => 'Str');
36 has UseAlternateFolderForOnline => (is => 'ro', isa => 'Bool');
37 has UsePathPrefix => (is => 'ro', isa => 'Str');
38 has Username => (is => 'ro', isa => 'Str');
39  
40 1;
41  
42 ### main pod documentation begin ###
43  
44 =head1 NAME
45  
46 Paws::DMS::OracleSettings
47  
48 =head1 USAGE
49  
50 This class represents one of two things:
51  
52 =head3 Arguments in a call to a service
53  
54 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
55 Each attribute should be used as a named argument in the calls that expect this type of object.
56  
57 As an example, if Att1 is expected to be a Paws::DMS::OracleSettings object:
58  
59 $service_obj->Method(Att1 => { AccessAlternateDirectly => $value, ..., Username => $value });
60  
61 =head3 Results returned from an API call
62  
63 Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::OracleSettings object:
64  
65 $result = $service_obj->Method(...);
66 $result->Att1->AccessAlternateDirectly
67  
68 =head1 DESCRIPTION
69  
70 Provides information that defines an Oracle endpoint.
71  
72 =head1 ATTRIBUTES
73  
74  
75 =head2 AccessAlternateDirectly => Bool
76  
77 Set this attribute to C<false> in order to use the Binary Reader to
78 capture change data for an Amazon RDS for Oracle as the source. This
79 tells the DMS instance to not access redo logs through any specified
80 path prefix replacement using direct file access.
81  
82  
83 =head2 AdditionalArchivedLogDestId => Int
84  
85 Set this attribute with C<archivedLogDestId> in a primary/ standby
86 setup. This attribute is useful in the case of a switchover. In this
87 case, AWS DMS needs to know which destination to get archive redo logs
88 from to read changes. This need arises because the previous primary
89 instance is now a standby instance after switchover.
90  
91  
92 =head2 AddSupplementalLogging => Bool
93  
94 Set this attribute to set up table-level supplemental logging for the
95 Oracle database. This attribute enables PRIMARY KEY supplemental
96 logging on all tables selected for a migration task.
97  
98 If you use this option, you still need to enable database-level
99 supplemental logging.
100  
101  
102 =head2 AllowSelectNestedTables => Bool
103  
104 Set this attribute to C<true> to enable replication of Oracle tables
105 containing columns that are nested tables or defined types.
106  
107  
108 =head2 ArchivedLogDestId => Int
109  
110 Specifies the destination of the archived redo logs. The value should
111 be the same as the DEST_ID number in the v$archived_log table. When
112 working with multiple log destinations (DEST_ID), we recommend that you
113 to specify an archived redo logs location identifier. Doing this
114 improves performance by ensuring that the correct logs are accessed
115 from the outset.
116  
117  
118 =head2 ArchivedLogsOnly => Bool
119  
120 When this field is set to C<Y>, AWS DMS only accesses the archived redo
121 logs. If the archived redo logs are stored on Oracle ASM only, the AWS
122 DMS user account needs to be granted ASM privileges.
123  
124  
125 =head2 AsmPassword => Str
126  
127 For an Oracle source endpoint, your Oracle Automatic Storage Management
128 (ASM) password. You can set this value from the C< I<asm_user_password>
129 > value. You set this value as part of the comma-separated value that
130 you set to the C<Password> request parameter when you create the
131 endpoint to access transaction logs using Binary Reader. For more
132 information, see Configuration for change data capture (CDC) on an
133 Oracle source database
134 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).
135  
136  
137 =head2 AsmServer => Str
138  
139 For an Oracle source endpoint, your ASM server address. You can set
140 this value from the C<asm_server> value. You set C<asm_server> as part
141 of the extra connection attribute string to access an Oracle server
142 with Binary Reader that uses ASM. For more information, see
143 Configuration for change data capture (CDC) on an Oracle source
144 database
145 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).
146  
147  
148 =head2 AsmUser => Str
149  
150 For an Oracle source endpoint, your ASM user name. You can set this
151 value from the C<asm_user> value. You set C<asm_user> as part of the
152 extra connection attribute string to access an Oracle server with
153 Binary Reader that uses ASM. For more information, see Configuration
154 for change data capture (CDC) on an Oracle source database
155 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration).
156  
157  
158 =head2 CharLengthSemantics => Str
159  
160 Specifies whether the length of a character column is in bytes or in
161 characters. To indicate that the character column length is in
162 characters, set this attribute to C<CHAR>. Otherwise, the character
163 column length is in bytes.
164  
165 Example: C<charLengthSemantics=CHAR;>
166  
167  
168 =head2 DatabaseName => Str
169  
170 Database name for the endpoint.
171  
172  
173 =head2 DirectPathNoLog => Bool
174  
175 When set to C<true>, this attribute helps to increase the commit rate
176 on the Oracle target database by writing directly to tables and not
177 writing a trail to database logs.
178  
179  
180 =head2 DirectPathParallelLoad => Bool
181  
182 When set to C<true>, this attribute specifies a parallel load when
183 C<useDirectPathFullLoad> is set to C<Y>. This attribute also only
184 applies when you use the AWS DMS parallel load feature. Note that the
185 target table cannot have any constraints or indexes.
186  
187  
188 =head2 EnableHomogenousTablespace => Bool
189  
190 Set this attribute to enable homogenous tablespace replication and
191 create existing tables or indexes under the same tablespace on the
192 target.
193  
194  
195 =head2 FailTasksOnLobTruncation => Bool
196  
197 When set to C<true>, this attribute causes a task to fail if the actual
198 size of an LOB column is greater than the specified C<LobMaxSize>.
199  
200 If a task is set to limited LOB mode and this option is set to C<true>,
201 the task fails instead of truncating the LOB data.
202  
203  
204 =head2 NumberDatatypeScale => Int
205  
206 Specifies the number scale. You can select a scale up to 38, or you can
207 select FLOAT. By default, the NUMBER data type is converted to
208 precision 38, scale 10.
209  
210 Example: C<numberDataTypeScale=12>
211  
212  
213 =head2 OraclePathPrefix => Str
214  
215 Set this string attribute to the required value in order to use the
216 Binary Reader to capture change data for an Amazon RDS for Oracle as
217 the source. This value specifies the default Oracle root used to access
218 the redo logs.
219  
220  
221 =head2 ParallelAsmReadThreads => Int
222  
223 Set this attribute to change the number of threads that DMS configures
224 to perform a Change Data Capture (CDC) load using Oracle Automatic
225 Storage Management (ASM). You can specify an integer value between 2
226 (the default) and 8 (the maximum). Use this attribute together with the
227 C<readAheadBlocks> attribute.
228  
229  
230 =head2 Password => Str
231  
232 Endpoint connection password.
233  
234  
235 =head2 Port => Int
236  
237 Endpoint TCP port.
238  
239  
240 =head2 ReadAheadBlocks => Int
241  
242 Set this attribute to change the number of read-ahead blocks that DMS
243 configures to perform a Change Data Capture (CDC) load using Oracle
244 Automatic Storage Management (ASM). You can specify an integer value
245 between 1000 (the default) and 200,000 (the maximum).
246  
247  
248 =head2 ReadTableSpaceName => Bool
249  
250 When set to C<true>, this attribute supports tablespace replication.
251  
252  
253 =head2 ReplacePathPrefix => Bool
254  
255 Set this attribute to true in order to use the Binary Reader to capture
256 change data for an Amazon RDS for Oracle as the source. This setting
257 tells DMS instance to replace the default Oracle root with the
258 specified C<usePathPrefix> setting to access the redo logs.
259  
260  
261 =head2 RetryInterval => Int
262  
263 Specifies the number of seconds that the system waits before resending
264 a query.
265  
266 Example: C<retryInterval=6;>
267  
268  
269 =head2 SecretsManagerAccessRoleArn => Str
270  
271 The full Amazon Resource Name (ARN) of the IAM role that specifies AWS
272 DMS as the trusted entity and grants the required permissions to access
273 the value in C<SecretsManagerSecret>. C<SecretsManagerSecret> has the
274 value of the AWS Secrets Manager secret that allows access to the
275 Oracle endpoint.
276  
277 You can specify one of two sets of values for these permissions. You
278 can specify the values for this setting and C<SecretsManagerSecretId>.
279 Or you can specify clear-text values for C<UserName>, C<Password>,
280 C<ServerName>, and C<Port>. You can't specify both. For more
281 information on creating this C<SecretsManagerSecret> and the
282 C<SecretsManagerAccessRoleArn> and C<SecretsManagerSecretId> required
283 to access it, see Using secrets to access AWS Database Migration
284 Service resources
285 (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
286 in the I<AWS Database Migration Service User Guide>.
287  
288  
289 =head2 SecretsManagerOracleAsmAccessRoleArn => Str
290  
291 Required only if your Oracle endpoint uses Advanced Storage Manager
292 (ASM). The full ARN of the IAM role that specifies AWS DMS as the
293 trusted entity and grants the required permissions to access the
294 C<SecretsManagerOracleAsmSecret>. This C<SecretsManagerOracleAsmSecret>
295 has the secret value that allows access to the Oracle ASM of the
296 endpoint.
297  
298 You can specify one of two sets of values for these permissions. You
299 can specify the values for this setting and
300 C<SecretsManagerOracleAsmSecretId>. Or you can specify clear-text
301 values for C<AsmUserName>, C<AsmPassword>, and C<AsmServerName>. You
302 can't specify both. For more information on creating this
303 C<SecretsManagerOracleAsmSecret> and the
304 C<SecretsManagerOracleAsmAccessRoleArn> and
305 C<SecretsManagerOracleAsmSecretId> required to access it, see Using
306 secrets to access AWS Database Migration Service resources
307 (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager)
308 in the I<AWS Database Migration Service User Guide>.
309  
310  
311 =head2 SecretsManagerOracleAsmSecretId => Str
312  
313 Required only if your Oracle endpoint uses Advanced Storage Manager
314 (ASM). The full ARN, partial ARN, or friendly name of the
315 C<SecretsManagerOracleAsmSecret> that contains the Oracle ASM
316 connection details for the Oracle endpoint.
317  
318  
319 =head2 SecretsManagerSecretId => Str
320  
321 The full ARN, partial ARN, or friendly name of the
322 C<SecretsManagerSecret> that contains the Oracle endpoint connection
323 details.
324  
325  
326 =head2 SecurityDbEncryption => Str
327  
328 For an Oracle source endpoint, the transparent data encryption (TDE)
329 password required by AWM DMS to access Oracle redo logs encrypted by
330 TDE using Binary Reader. It is also the C< I<TDE_Password> > part of
331 the comma-separated value you set to the C<Password> request parameter
332 when you create the endpoint. The C<SecurityDbEncryptian> setting is
333 related to this C<SecurityDbEncryptionName> setting. For more
334 information, see Supported encryption methods for using Oracle as a
335 source for AWS DMS
336 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption)
337 in the I<AWS Database Migration Service User Guide>.
338  
339  
340 =head2 SecurityDbEncryptionName => Str
341  
342 For an Oracle source endpoint, the name of a key used for the
343 transparent data encryption (TDE) of the columns and tablespaces in an
344 Oracle source database that is encrypted using TDE. The key value is
345 the value of the C<SecurityDbEncryption> setting. For more information
346 on setting the key name value of C<SecurityDbEncryptionName>, see the
347 information and example for setting the C<securityDbEncryptionName>
348 extra connection attribute in Supported encryption methods for using
349 Oracle as a source for AWS DMS
350 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption)
351 in the I<AWS Database Migration Service User Guide>.
352  
353  
354 =head2 ServerName => Str
355  
356 Fully qualified domain name of the endpoint.
357  
358  
359 =head2 SpatialDataOptionToGeoJsonFunctionName => Str
360  
361 Use this attribute to convert C<SDO_GEOMETRY> to C<GEOJSON> format. By
362 default, DMS calls the C<SDO2GEOJSON> custom function if present and
363 accessible. Or you can create your own custom function that mimics the
364 operation of C<SDOGEOJSON> and set
365 C<SpatialDataOptionToGeoJsonFunctionName> to call it instead.
366  
367  
368 =head2 UseAlternateFolderForOnline => Bool
369  
370 Set this attribute to C<true> in order to use the Binary Reader to
371 capture change data for an Amazon RDS for Oracle as the source. This
372 tells the DMS instance to use any specified prefix replacement to
373 access all online redo logs.
374  
375  
376 =head2 UsePathPrefix => Str
377  
378 Set this string attribute to the required value in order to use the
379 Binary Reader to capture change data for an Amazon RDS for Oracle as
380 the source. This value specifies the path prefix used to replace the
381 default Oracle root to access the redo logs.
382  
383  
384 =head2 Username => Str
385  
386 Endpoint connection user name.
387  
388  
389  
390 =head1 SEE ALSO
391  
392 This class forms part of L<Paws>, describing an object used in L<Paws::DMS>
393  
394 =head1 BUGS and CONTRIBUTIONS
395  
396 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
397  
398 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
399  
400 =cut
401