/AWS1/CL_DMGORACLESETTINGS

Provides information that defines an Oracle endpoint.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_addsupplementallogging TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.

If you use this option, you still need to enable database-level supplemental logging.

iv_archivedlogdestid TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.

iv_addlarchivedlogdestid TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

it_extraarchivedlogdestids TYPE /AWS1/CL_DMGINTEGERLIST_W=>TT_INTEGERLIST TT_INTEGERLIST

Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the dest_id column in the v$archived_log view. Use this setting with the archivedLogDestId extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.

This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2]

In a primary-to-multiple-standby setup, you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

iv_allowselectnestedtables TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.

iv_parallelasmreadthreads TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.

iv_readaheadblocks TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).

iv_accessalternatedirectly TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.

iv_usealternatefolderforon00 TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.

iv_oraclepathprefix TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.

iv_usepathprefix TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.

iv_replacepathprefix TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.

iv_enbhomogenoustablespace TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.

iv_directpathnolog TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.

iv_archivedlogsonly TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

When this field is set to True, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.

iv_asmpassword TYPE /AWS1/DMGSECRETSTRING /AWS1/DMGSECRETSTRING

For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the asm_user_password value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

iv_asmserver TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

iv_asmuser TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

iv_charlengthsemantics TYPE /AWS1/DMGCHARLENGTHSEMANTICS /AWS1/DMGCHARLENGTHSEMANTICS

Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes.

Example: charLengthSemantics=CHAR;

iv_databasename TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Database name for the endpoint.

iv_directpathparallelload TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.

iv_failtasksonlobtruncation TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.

If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

iv_numberdatatypescale TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.

Example: numberDataTypeScale=12

iv_password TYPE /AWS1/DMGSECRETSTRING /AWS1/DMGSECRETSTRING

Endpoint connection password.

iv_port TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Endpoint TCP port.

iv_readtablespacename TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

When set to true, this attribute supports tablespace replication.

iv_retryinterval TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Specifies the number of seconds that the system waits before resending a query.

Example: retryInterval=6;

iv_securitydbencryption TYPE /AWS1/DMGSECRETSTRING /AWS1/DMGSECRETSTRING

For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

iv_securitydbencryptionname TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

iv_servername TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

iv_spatialdataoptiontogeoj00 TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName to call it instead.

iv_standbydelaytime TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.

In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.

iv_username TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Endpoint connection user name.

iv_usebfile TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to True to capture change data using the Binary Reader utility. Set UseLogminerReader to False to set this attribute to True. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC.

iv_usedirectpathfullload TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to True to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.

iv_uselogminerreader TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Set this attribute to True to capture change data using the Oracle LogMiner utility (the default). Set this attribute to False if you want to access the redo logs as a binary file. When you set UseLogminerReader to False, also set UseBfile to True. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.

iv_secretsmanageraccrolearn TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

iv_secretsmanagersecretid TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.

iv_secretsmanageroracleasm00 TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUser, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

iv_secretsmanageroracleasm01 TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

iv_trimspaceinchar TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

iv_converttsmpwithzonetoutc TYPE /AWS1/DMGBOOLEANOPTIONAL /AWS1/DMGBOOLEANOPTIONAL

When true, converts timestamps with the timezone datatype to their UTC value.

iv_opentransactionwindow TYPE /AWS1/DMGINTEGEROPTIONAL /AWS1/DMGINTEGEROPTIONAL

The timeframe in minutes to check for open transactions for a CDC-only task.

You can specify an integer value between 0 (the default) and 240 (the maximum).

This parameter is only valid in DMS version 3.5.0 and later.

iv_authenticationmethod TYPE /AWS1/DMGORACLEAUTHNTCTNMETHOD /AWS1/DMGORACLEAUTHNTCTNMETHOD

Specifies the authentication method to be used with Oracle.

---

Queryable Attributes

AddSupplementalLogging

Set this attribute to set up table-level supplemental logging for the Oracle database. This attribute enables PRIMARY KEY supplemental logging on all tables selected for a migration task.

If you use this option, you still need to enable database-level supplemental logging.

Accessible with the following methods

Method	Description
GET_ADDSUPPLEMENTALLOGGING()	Getter for ADDSUPPLEMENTALLOGGING, with configurable default
ASK_ADDSUPPLEMENTALLOGGING()	Getter for ADDSUPPLEMENTALLOGGING w/ exceptions if field has
HAS_ADDSUPPLEMENTALLOGGING()	Determine if ADDSUPPLEMENTALLOGGING has a value

ArchivedLogDestId

Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the dest_id column of the v$archived_log view. If you work with an additional redo log destination, use the AdditionalArchivedLogDestId option to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.

Accessible with the following methods

Method	Description
GET_ARCHIVEDLOGDESTID()	Getter for ARCHIVEDLOGDESTID, with configurable default
ASK_ARCHIVEDLOGDESTID()	Getter for ARCHIVEDLOGDESTID w/ exceptions if field has no v
HAS_ARCHIVEDLOGDESTID()	Determine if ARCHIVEDLOGDESTID has a value

AdditionalArchivedLogDestId

Set this attribute with ArchivedLogDestId in a primary/ standby setup. This attribute is useful in the case of a switchover. In this case, DMS needs to know which destination to get archive redo logs from to read changes. This need arises because the previous primary instance is now a standby instance after switchover.

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless necessary. For additional information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

Accessible with the following methods

Method	Description
GET_ADDLARCHIVEDLOGDESTID()	Getter for ADDITIONALARCHIVEDLOGDESTID, with configurable de
ASK_ADDLARCHIVEDLOGDESTID()	Getter for ADDITIONALARCHIVEDLOGDESTID w/ exceptions if fiel
HAS_ADDLARCHIVEDLOGDESTID()	Determine if ADDITIONALARCHIVEDLOGDESTID has a value

ExtraArchivedLogDestIds

Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the dest_id column in the v$archived_log view. Use this setting with the archivedLogDestId extra connection attribute in a primary-to-single setup or a primary-to-multiple-standby setup.

This setting is useful in a switchover when you use an Oracle Data Guard database as a source. In this case, DMS needs information about what destination to get archive redo logs from to read changes. DMS needs this because after the switchover the previous primary is a standby instance. For example, in a primary-to-single standby setup you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2]

In a primary-to-multiple-standby setup, you might apply the following settings.

archivedLogDestId=1; ExtraArchivedLogDestIds=[2,3,4]

Although DMS supports the use of the Oracle RESETLOGS option to open the database, never use RESETLOGS unless it's necessary. For more information about RESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.

Accessible with the following methods

Method	Description
GET_EXTRAARCHIVEDLOGDESTIDS()	Getter for EXTRAARCHIVEDLOGDESTIDS, with configurable defaul
ASK_EXTRAARCHIVEDLOGDESTIDS()	Getter for EXTRAARCHIVEDLOGDESTIDS w/ exceptions if field ha
HAS_EXTRAARCHIVEDLOGDESTIDS()	Determine if EXTRAARCHIVEDLOGDESTIDS has a value

AllowSelectNestedTables

Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.

Accessible with the following methods

Method	Description
GET_ALLOWSELECTNESTEDTABLES()	Getter for ALLOWSELECTNESTEDTABLES, with configurable defaul
ASK_ALLOWSELECTNESTEDTABLES()	Getter for ALLOWSELECTNESTEDTABLES w/ exceptions if field ha
HAS_ALLOWSELECTNESTEDTABLES()	Determine if ALLOWSELECTNESTEDTABLES has a value

ParallelAsmReadThreads

Set this attribute to change the number of threads that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.

Accessible with the following methods

Method	Description
GET_PARALLELASMREADTHREADS()	Getter for PARALLELASMREADTHREADS, with configurable default
ASK_PARALLELASMREADTHREADS()	Getter for PARALLELASMREADTHREADS w/ exceptions if field has
HAS_PARALLELASMREADTHREADS()	Determine if PARALLELASMREADTHREADS has a value

ReadAheadBlocks

Set this attribute to change the number of read-ahead blocks that DMS configures to perform a change data capture (CDC) load using Oracle Automatic Storage Management (ASM). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).

Accessible with the following methods

Method	Description
GET_READAHEADBLOCKS()	Getter for READAHEADBLOCKS, with configurable default
ASK_READAHEADBLOCKS()	Getter for READAHEADBLOCKS w/ exceptions if field has no val
HAS_READAHEADBLOCKS()	Determine if READAHEADBLOCKS has a value

AccessAlternateDirectly

Set this attribute to false in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.

Accessible with the following methods

Method	Description
GET_ACCESSALTERNATEDIRECTLY()	Getter for ACCESSALTERNATEDIRECTLY, with configurable defaul
ASK_ACCESSALTERNATEDIRECTLY()	Getter for ACCESSALTERNATEDIRECTLY w/ exceptions if field ha
HAS_ACCESSALTERNATEDIRECTLY()	Determine if ACCESSALTERNATEDIRECTLY has a value

UseAlternateFolderForOnline

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This tells the DMS instance to use any specified prefix replacement to access all online redo logs.

Accessible with the following methods

Method	Description
GET_USEALTERNATEFOLDERFORO00()	Getter for USEALTERNATEFOLDERFORONLINE, with configurable de
ASK_USEALTERNATEFOLDERFORO00()	Getter for USEALTERNATEFOLDERFORONLINE w/ exceptions if fiel
HAS_USEALTERNATEFOLDERFORO00()	Determine if USEALTERNATEFOLDERFORONLINE has a value

OraclePathPrefix

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the default Oracle root used to access the redo logs.

Accessible with the following methods

Method	Description
GET_ORACLEPATHPREFIX()	Getter for ORACLEPATHPREFIX, with configurable default
ASK_ORACLEPATHPREFIX()	Getter for ORACLEPATHPREFIX w/ exceptions if field has no va
HAS_ORACLEPATHPREFIX()	Determine if ORACLEPATHPREFIX has a value

UsePathPrefix

Set this string attribute to the required value in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.

Accessible with the following methods

Method	Description
GET_USEPATHPREFIX()	Getter for USEPATHPREFIX, with configurable default
ASK_USEPATHPREFIX()	Getter for USEPATHPREFIX w/ exceptions if field has no value
HAS_USEPATHPREFIX()	Determine if USEPATHPREFIX has a value

ReplacePathPrefix

Set this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source. This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.

Accessible with the following methods

Method	Description
GET_REPLACEPATHPREFIX()	Getter for REPLACEPATHPREFIX, with configurable default
ASK_REPLACEPATHPREFIX()	Getter for REPLACEPATHPREFIX w/ exceptions if field has no v
HAS_REPLACEPATHPREFIX()	Determine if REPLACEPATHPREFIX has a value

EnableHomogenousTablespace

Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.

Accessible with the following methods

Method	Description
GET_ENBHOMOGENOUSTABLESPACE()	Getter for ENABLEHOMOGENOUSTABLESPACE, with configurable def
ASK_ENBHOMOGENOUSTABLESPACE()	Getter for ENABLEHOMOGENOUSTABLESPACE w/ exceptions if field
HAS_ENBHOMOGENOUSTABLESPACE()	Determine if ENABLEHOMOGENOUSTABLESPACE has a value

DirectPathNoLog

When set to true, this attribute helps to increase the commit rate on the Oracle target database by writing directly to tables and not writing a trail to database logs.

Accessible with the following methods

Method	Description
GET_DIRECTPATHNOLOG()	Getter for DIRECTPATHNOLOG, with configurable default
ASK_DIRECTPATHNOLOG()	Getter for DIRECTPATHNOLOG w/ exceptions if field has no val
HAS_DIRECTPATHNOLOG()	Determine if DIRECTPATHNOLOG has a value

ArchivedLogsOnly

When this field is set to True, DMS only accesses the archived redo logs. If the archived redo logs are stored on Automatic Storage Management (ASM) only, the DMS user account needs to be granted ASM privileges.

Accessible with the following methods

Method	Description
GET_ARCHIVEDLOGSONLY()	Getter for ARCHIVEDLOGSONLY, with configurable default
ASK_ARCHIVEDLOGSONLY()	Getter for ARCHIVEDLOGSONLY w/ exceptions if field has no va
HAS_ARCHIVEDLOGSONLY()	Determine if ARCHIVEDLOGSONLY has a value

AsmPassword

For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the asm_user_password value. You set this value as part of the comma-separated value that you set to the Password request parameter when you create the endpoint to access transaction logs using Binary Reader. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

Accessible with the following methods

Method	Description
GET_ASMPASSWORD()	Getter for ASMPASSWORD, with configurable default
ASK_ASMPASSWORD()	Getter for ASMPASSWORD w/ exceptions if field has no value
HAS_ASMPASSWORD()	Determine if ASMPASSWORD has a value

AsmServer

For an Oracle source endpoint, your ASM server address. You can set this value from the asm_server value. You set asm_server as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

Accessible with the following methods

Method	Description
GET_ASMSERVER()	Getter for ASMSERVER, with configurable default
ASK_ASMSERVER()	Getter for ASMSERVER w/ exceptions if field has no value
HAS_ASMSERVER()	Determine if ASMSERVER has a value

AsmUser

For an Oracle source endpoint, your ASM user name. You can set this value from the asm_user value. You set asm_user as part of the extra connection attribute string to access an Oracle server with Binary Reader that uses ASM. For more information, see Configuration for change data capture (CDC) on an Oracle source database.

Accessible with the following methods

Method	Description
GET_ASMUSER()	Getter for ASMUSER, with configurable default
ASK_ASMUSER()	Getter for ASMUSER w/ exceptions if field has no value
HAS_ASMUSER()	Determine if ASMUSER has a value

CharLengthSemantics

Specifies whether the length of a character column is in bytes or in characters. To indicate that the character column length is in characters, set this attribute to CHAR. Otherwise, the character column length is in bytes.

Example: charLengthSemantics=CHAR;

Accessible with the following methods

Method	Description
GET_CHARLENGTHSEMANTICS()	Getter for CHARLENGTHSEMANTICS, with configurable default
ASK_CHARLENGTHSEMANTICS()	Getter for CHARLENGTHSEMANTICS w/ exceptions if field has no
HAS_CHARLENGTHSEMANTICS()	Determine if CHARLENGTHSEMANTICS has a value

DatabaseName

Database name for the endpoint.

Accessible with the following methods

Method	Description
GET_DATABASENAME()	Getter for DATABASENAME, with configurable default
ASK_DATABASENAME()	Getter for DATABASENAME w/ exceptions if field has no value
HAS_DATABASENAME()	Determine if DATABASENAME has a value

DirectPathParallelLoad

When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.

Accessible with the following methods

Method	Description
GET_DIRECTPATHPARALLELLOAD()	Getter for DIRECTPATHPARALLELLOAD, with configurable default
ASK_DIRECTPATHPARALLELLOAD()	Getter for DIRECTPATHPARALLELLOAD w/ exceptions if field has
HAS_DIRECTPATHPARALLELLOAD()	Determine if DIRECTPATHPARALLELLOAD has a value

FailTasksOnLobTruncation

When set to true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize.

If a task is set to limited LOB mode and this option is set to true, the task fails instead of truncating the LOB data.

Accessible with the following methods

Method	Description
GET_FAILTASKSONLOBTRUNCATION()	Getter for FAILTASKSONLOBTRUNCATION, with configurable defau
ASK_FAILTASKSONLOBTRUNCATION()	Getter for FAILTASKSONLOBTRUNCATION w/ exceptions if field h
HAS_FAILTASKSONLOBTRUNCATION()	Determine if FAILTASKSONLOBTRUNCATION has a value

NumberDatatypeScale

Specifies the number scale. You can select a scale up to 38, or you can select FLOAT. By default, the NUMBER data type is converted to precision 38, scale 10.

Example: numberDataTypeScale=12

Accessible with the following methods

Method	Description
GET_NUMBERDATATYPESCALE()	Getter for NUMBERDATATYPESCALE, with configurable default
ASK_NUMBERDATATYPESCALE()	Getter for NUMBERDATATYPESCALE w/ exceptions if field has no
HAS_NUMBERDATATYPESCALE()	Determine if NUMBERDATATYPESCALE has a value

Password

Endpoint connection password.

Accessible with the following methods

Method	Description
GET_PASSWORD()	Getter for PASSWORD, with configurable default
ASK_PASSWORD()	Getter for PASSWORD w/ exceptions if field has no value
HAS_PASSWORD()	Determine if PASSWORD has a value

Port

Endpoint TCP port.

Accessible with the following methods

Method	Description
GET_PORT()	Getter for PORT, with configurable default
ASK_PORT()	Getter for PORT w/ exceptions if field has no value
HAS_PORT()	Determine if PORT has a value

ReadTableSpaceName

When set to true, this attribute supports tablespace replication.

Accessible with the following methods

Method	Description
GET_READTABLESPACENAME()	Getter for READTABLESPACENAME, with configurable default
ASK_READTABLESPACENAME()	Getter for READTABLESPACENAME w/ exceptions if field has no
HAS_READTABLESPACENAME()	Determine if READTABLESPACENAME has a value

RetryInterval

Specifies the number of seconds that the system waits before resending a query.

Example: retryInterval=6;

Accessible with the following methods

Method	Description
GET_RETRYINTERVAL()	Getter for RETRYINTERVAL, with configurable default
ASK_RETRYINTERVAL()	Getter for RETRYINTERVAL w/ exceptions if field has no value
HAS_RETRYINTERVAL()	Determine if RETRYINTERVAL has a value

SecurityDbEncryption

For an Oracle source endpoint, the transparent data encryption (TDE) password required by AWM DMS to access Oracle redo logs encrypted by TDE using Binary Reader. It is also the TDE_Password part of the comma-separated value you set to the Password request parameter when you create the endpoint. The SecurityDbEncryptian setting is related to this SecurityDbEncryptionName setting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

Accessible with the following methods

Method	Description
GET_SECURITYDBENCRYPTION()	Getter for SECURITYDBENCRYPTION, with configurable default
ASK_SECURITYDBENCRYPTION()	Getter for SECURITYDBENCRYPTION w/ exceptions if field has n
HAS_SECURITYDBENCRYPTION()	Determine if SECURITYDBENCRYPTION has a value

SecurityDbEncryptionName

For an Oracle source endpoint, the name of a key used for the transparent data encryption (TDE) of the columns and tablespaces in an Oracle source database that is encrypted using TDE. The key value is the value of the SecurityDbEncryption setting. For more information on setting the key name value of SecurityDbEncryptionName, see the information and example for setting the securityDbEncryptionName extra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.

Accessible with the following methods

Method	Description
GET_SECURITYDBENCRYPTIONNAME()	Getter for SECURITYDBENCRYPTIONNAME, with configurable defau
ASK_SECURITYDBENCRYPTIONNAME()	Getter for SECURITYDBENCRYPTIONNAME w/ exceptions if field h
HAS_SECURITYDBENCRYPTIONNAME()	Determine if SECURITYDBENCRYPTIONNAME has a value

ServerName

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

Accessible with the following methods

Method	Description
GET_SERVERNAME()	Getter for SERVERNAME, with configurable default
ASK_SERVERNAME()	Getter for SERVERNAME w/ exceptions if field has no value
HAS_SERVERNAME()	Determine if SERVERNAME has a value

SpatialDataOptionToGeoJsonFunctionName

Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible. Or you can create your own custom function that mimics the operation of SDOGEOJSON and set SpatialDataOptionToGeoJsonFunctionName to call it instead.

Accessible with the following methods

Method	Description
GET_SPATIALDATAOPTIONTOGEO00()	Getter for SPATIALDATAOPTIONTOGEOJSON00, with configurable d
ASK_SPATIALDATAOPTIONTOGEO00()	Getter for SPATIALDATAOPTIONTOGEOJSON00 w/ exceptions if fie
HAS_SPATIALDATAOPTIONTOGEO00()	Determine if SPATIALDATAOPTIONTOGEOJSON00 has a value

StandbyDelayTime

Use this attribute to specify a time in minutes for the delay in standby sync. If the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.

In DMS, you can create an Oracle CDC task that uses an Active Data Guard standby instance as a source for replicating ongoing changes. Doing this eliminates the need to connect to an active database that might be in production.

Accessible with the following methods

Method	Description
GET_STANDBYDELAYTIME()	Getter for STANDBYDELAYTIME, with configurable default
ASK_STANDBYDELAYTIME()	Getter for STANDBYDELAYTIME w/ exceptions if field has no va
HAS_STANDBYDELAYTIME()	Determine if STANDBYDELAYTIME has a value

Username

Endpoint connection user name.

Accessible with the following methods

Method	Description
GET_USERNAME()	Getter for USERNAME, with configurable default
ASK_USERNAME()	Getter for USERNAME w/ exceptions if field has no value
HAS_USERNAME()	Determine if USERNAME has a value

UseBFile

Set this attribute to True to capture change data using the Binary Reader utility. Set UseLogminerReader to False to set this attribute to True. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or DMS Binary Reader for CDC.

Accessible with the following methods

Method	Description
GET_USEBFILE()	Getter for USEBFILE, with configurable default
ASK_USEBFILE()	Getter for USEBFILE w/ exceptions if field has no value
HAS_USEBFILE()	Determine if USEBFILE has a value

UseDirectPathFullLoad

Set this attribute to True to have DMS use a direct path full load. Specify this value to use the direct path protocol in the Oracle Call Interface (OCI). By using this OCI protocol, you can bulk-load Oracle target tables during a full load.

Accessible with the following methods

Method	Description
GET_USEDIRECTPATHFULLLOAD()	Getter for USEDIRECTPATHFULLLOAD, with configurable default
ASK_USEDIRECTPATHFULLLOAD()	Getter for USEDIRECTPATHFULLLOAD w/ exceptions if field has
HAS_USEDIRECTPATHFULLLOAD()	Determine if USEDIRECTPATHFULLLOAD has a value

UseLogminerReader

Set this attribute to True to capture change data using the Oracle LogMiner utility (the default). Set this attribute to False if you want to access the redo logs as a binary file. When you set UseLogminerReader to False, also set UseBfile to True. For more information on this setting and using Oracle ASM, see Using Oracle LogMiner or DMS Binary Reader for CDC in the DMS User Guide.

Accessible with the following methods

Method	Description
GET_USELOGMINERREADER()	Getter for USELOGMINERREADER, with configurable default
ASK_USELOGMINERREADER()	Getter for USELOGMINERREADER w/ exceptions if field has no v
HAS_USELOGMINERREADER()	Determine if USELOGMINERREADER has a value

SecretsManagerAccessRoleArn

The full Amazon Resource Name (ARN) of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the value in SecretsManagerSecret. The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the Amazon Web Services Secrets Manager secret that allows access to the Oracle endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerSecretId. Or you can specify clear-text values for UserName, Password, ServerName, and Port. You can't specify both. For more information on creating this SecretsManagerSecret and the SecretsManagerAccessRoleArn and SecretsManagerSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Accessible with the following methods

Method	Description
GET_SECRETSMANAGERACCROLEARN()	Getter for SECRETSMANAGERACCESSROLEARN, with configurable de
ASK_SECRETSMANAGERACCROLEARN()	Getter for SECRETSMANAGERACCESSROLEARN w/ exceptions if fiel
HAS_SECRETSMANAGERACCROLEARN()	Determine if SECRETSMANAGERACCESSROLEARN has a value

SecretsManagerSecretId

The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.

Accessible with the following methods

Method	Description
GET_SECRETSMANAGERSECRETID()	Getter for SECRETSMANAGERSECRETID, with configurable default
ASK_SECRETSMANAGERSECRETID()	Getter for SECRETSMANAGERSECRETID w/ exceptions if field has
HAS_SECRETSMANAGERSECRETID()	Determine if SECRETSMANAGERSECRETID has a value

SecretsManagerOracleAsmAccessRoleArn

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies DMS as the trusted entity and grants the required permissions to access the SecretsManagerOracleAsmSecret. This SecretsManagerOracleAsmSecret has the secret value that allows access to the Oracle ASM of the endpoint.

You can specify one of two sets of values for these permissions. You can specify the values for this setting and SecretsManagerOracleAsmSecretId. Or you can specify clear-text values for AsmUser, AsmPassword, and AsmServerName. You can't specify both. For more information on creating this SecretsManagerOracleAsmSecret and the SecretsManagerOracleAsmAccessRoleArn and SecretsManagerOracleAsmSecretId required to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.

Accessible with the following methods

Method	Description
GET_SECRETSMANAGERORACLEAS00()	Getter for SECRETSMANAGERORACLEASMACC00, with configurable d
ASK_SECRETSMANAGERORACLEAS00()	Getter for SECRETSMANAGERORACLEASMACC00 w/ exceptions if fie
HAS_SECRETSMANAGERORACLEAS00()	Determine if SECRETSMANAGERORACLEASMACC00 has a value

SecretsManagerOracleAsmSecretId

Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

Accessible with the following methods

Method	Description
GET_SECRETSMANAGERORACLEAS01()	Getter for SECRETSMANAGERORACLEASMSEC00, with configurable d
ASK_SECRETSMANAGERORACLEAS01()	Getter for SECRETSMANAGERORACLEASMSEC00 w/ exceptions if fie
HAS_SECRETSMANAGERORACLEAS01()	Determine if SECRETSMANAGERORACLEASMSEC00 has a value

TrimSpaceInChar

Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value is true.

Accessible with the following methods

Method	Description
GET_TRIMSPACEINCHAR()	Getter for TRIMSPACEINCHAR, with configurable default
ASK_TRIMSPACEINCHAR()	Getter for TRIMSPACEINCHAR w/ exceptions if field has no val
HAS_TRIMSPACEINCHAR()	Determine if TRIMSPACEINCHAR has a value

ConvertTimestampWithZoneToUTC

When true, converts timestamps with the timezone datatype to their UTC value.

Accessible with the following methods

Method	Description
GET_CONVERTTSMPWITHZONETOUTC()	Getter for CONVERTTSMPWITHZONETOUTC, with configurable defau
ASK_CONVERTTSMPWITHZONETOUTC()	Getter for CONVERTTSMPWITHZONETOUTC w/ exceptions if field h
HAS_CONVERTTSMPWITHZONETOUTC()	Determine if CONVERTTSMPWITHZONETOUTC has a value

OpenTransactionWindow

The timeframe in minutes to check for open transactions for a CDC-only task.

You can specify an integer value between 0 (the default) and 240 (the maximum).

This parameter is only valid in DMS version 3.5.0 and later.

Accessible with the following methods

Method	Description
GET_OPENTRANSACTIONWINDOW()	Getter for OPENTRANSACTIONWINDOW, with configurable default
ASK_OPENTRANSACTIONWINDOW()	Getter for OPENTRANSACTIONWINDOW w/ exceptions if field has
HAS_OPENTRANSACTIONWINDOW()	Determine if OPENTRANSACTIONWINDOW has a value

AuthenticationMethod

Specifies the authentication method to be used with Oracle.

Accessible with the following methods

Method	Description
GET_AUTHENTICATIONMETHOD()	Getter for AUTHENTICATIONMETHOD, with configurable default
ASK_AUTHENTICATIONMETHOD()	Getter for AUTHENTICATIONMETHOD w/ exceptions if field has n
HAS_AUTHENTICATIONMETHOD()	Determine if AUTHENTICATIONMETHOD has a value