software.amazon.awssdk.services.databasemigration.model

Interface OracleSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<OracleSettings.Builder,OracleSettings>, SdkBuilder<OracleSettings.Builder,OracleSettings>, SdkPojo

Enclosing class:

OracleSettings

public static interface OracleSettings.Builder
extends SdkPojo, CopyableBuilder<OracleSettings.Builder,OracleSettings>

Method Summary

Modifier and Type	Method and Description
OracleSettings.Builder	accessAlternateDirectly(Boolean 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.
OracleSettings.Builder	additionalArchivedLogDestId(Integer additionalArchivedLogDestId) Set this attribute with ArchivedLogDestId in a primary/ standby setup.
OracleSettings.Builder	addSupplementalLogging(Boolean addSupplementalLogging) Set this attribute to set up table-level supplemental logging for the Oracle database.
OracleSettings.Builder	allowSelectNestedTables(Boolean allowSelectNestedTables) Set this attribute to true to enable replication of Oracle tables containing columns that are nested tables or defined types.
OracleSettings.Builder	archivedLogDestId(Integer archivedLogDestId) Specifies the ID of the destination for the archived redo logs.
OracleSettings.Builder	archivedLogsOnly(Boolean archivedLogsOnly) When this field is set to Y, DMS only accesses the archived redo logs.
OracleSettings.Builder	asmPassword(String asmPassword) For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
OracleSettings.Builder	asmServer(String asmServer) For an Oracle source endpoint, your ASM server address.
OracleSettings.Builder	asmUser(String asmUser) For an Oracle source endpoint, your ASM user name.
OracleSettings.Builder	charLengthSemantics(CharLengthSemantics charLengthSemantics) Specifies whether the length of a character column is in bytes or in characters.
OracleSettings.Builder	charLengthSemantics(String charLengthSemantics) Specifies whether the length of a character column is in bytes or in characters.
OracleSettings.Builder	convertTimestampWithZoneToUTC(Boolean convertTimestampWithZoneToUTC) When true, converts timestamps with the timezone datatype to their UTC value.
OracleSettings.Builder	databaseName(String databaseName) Database name for the endpoint.
OracleSettings.Builder	directPathNoLog(Boolean 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.
OracleSettings.Builder	directPathParallelLoad(Boolean directPathParallelLoad) When set to true, this attribute specifies a parallel load when useDirectPathFullLoad is set to Y.
OracleSettings.Builder	enableHomogenousTablespace(Boolean enableHomogenousTablespace) Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
OracleSettings.Builder	extraArchivedLogDestIds(Collection<Integer> extraArchivedLogDestIds) Specifies the IDs of one more destinations for one or more archived redo logs.
OracleSettings.Builder	extraArchivedLogDestIds(Integer... extraArchivedLogDestIds) Specifies the IDs of one more destinations for one or more archived redo logs.
OracleSettings.Builder	failTasksOnLobTruncation(Boolean 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.
OracleSettings.Builder	numberDatatypeScale(Integer numberDatatypeScale) Specifies the number scale.
OracleSettings.Builder	openTransactionWindow(Integer openTransactionWindow) The timeframe in minutes to check for open transactions for a CDC-only task.
OracleSettings.Builder	oraclePathPrefix(String 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.
OracleSettings.Builder	parallelAsmReadThreads(Integer 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).
OracleSettings.Builder	password(String password) Endpoint connection password.
OracleSettings.Builder	port(Integer port) Endpoint TCP port.
OracleSettings.Builder	readAheadBlocks(Integer 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).
OracleSettings.Builder	readTableSpaceName(Boolean readTableSpaceName) When set to true, this attribute supports tablespace replication.
OracleSettings.Builder	replacePathPrefix(Boolean 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.
OracleSettings.Builder	retryInterval(Integer retryInterval) Specifies the number of seconds that the system waits before resending a query.
OracleSettings.Builder	secretsManagerAccessRoleArn(String 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.
OracleSettings.Builder	secretsManagerOracleAsmAccessRoleArn(String secretsManagerOracleAsmAccessRoleArn) Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
OracleSettings.Builder	secretsManagerOracleAsmSecretId(String secretsManagerOracleAsmSecretId) Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
OracleSettings.Builder	secretsManagerSecretId(String secretsManagerSecretId) The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle endpoint connection details.
OracleSettings.Builder	securityDbEncryption(String 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.
OracleSettings.Builder	securityDbEncryptionName(String 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.
OracleSettings.Builder	serverName(String serverName) Fully qualified domain name of the endpoint.
OracleSettings.Builder	spatialDataOptionToGeoJsonFunctionName(String spatialDataOptionToGeoJsonFunctionName) Use this attribute to convert SDO_GEOMETRY to GEOJSON format.
OracleSettings.Builder	standbyDelayTime(Integer standbyDelayTime) Use this attribute to specify a time in minutes for the delay in standby sync.
OracleSettings.Builder	trimSpaceInChar(Boolean trimSpaceInChar) Use the TrimSpaceInChar source endpoint setting to trim data on CHAR and NCHAR data types during migration.
OracleSettings.Builder	useAlternateFolderForOnline(Boolean 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.
OracleSettings.Builder	useBFile(Boolean useBFile) Set this attribute to Y to capture change data using the Binary Reader utility.
OracleSettings.Builder	useDirectPathFullLoad(Boolean useDirectPathFullLoad) Set this attribute to Y to have DMS use a direct path full load.
OracleSettings.Builder	useLogminerReader(Boolean useLogminerReader) Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default).
OracleSettings.Builder	usePathPrefix(String 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.
OracleSettings.Builder	username(String username) Endpoint connection user name.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

addSupplementalLogging

OracleSettings.Builder addSupplementalLogging(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

archivedLogDestId

OracleSettings.Builder archivedLogDestId(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalArchivedLogDestId

OracleSettings.Builder additionalArchivedLogDestId(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

extraArchivedLogDestIds

OracleSettings.Builder extraArchivedLogDestIds(Collection<Integer> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

extraArchivedLogDestIds

OracleSettings.Builder extraArchivedLogDestIds(Integer... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

allowSelectNestedTables

OracleSettings.Builder allowSelectNestedTables(Boolean allowSelectNestedTables)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

parallelAsmReadThreads

OracleSettings.Builder parallelAsmReadThreads(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

readAheadBlocks

OracleSettings.Builder readAheadBlocks(Integer 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).

Parameters:

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).

Returns:

Returns a reference to this object so that method calls can be chained together.

accessAlternateDirectly

OracleSettings.Builder accessAlternateDirectly(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

useAlternateFolderForOnline

OracleSettings.Builder useAlternateFolderForOnline(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

oraclePathPrefix

OracleSettings.Builder oraclePathPrefix(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

usePathPrefix

OracleSettings.Builder usePathPrefix(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

replacePathPrefix

OracleSettings.Builder replacePathPrefix(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

enableHomogenousTablespace

OracleSettings.Builder enableHomogenousTablespace(Boolean enableHomogenousTablespace)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

directPathNoLog

OracleSettings.Builder directPathNoLog(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

archivedLogsOnly

OracleSettings.Builder archivedLogsOnly(Boolean archivedLogsOnly)

When this field is set to Y, 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.

Parameters:

archivedLogsOnly - When this field is set to Y, 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

asmPassword

OracleSettings.Builder asmPassword(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

asmServer

OracleSettings.Builder asmServer(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

asmUser

OracleSettings.Builder asmUser(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

charLengthSemantics

OracleSettings.Builder charLengthSemantics(String 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;

Parameters:

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;

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CharLengthSemantics, CharLengthSemantics

charLengthSemantics

OracleSettings.Builder charLengthSemantics(CharLengthSemantics 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;

Parameters:

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;

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CharLengthSemantics, CharLengthSemantics

databaseName

OracleSettings.Builder databaseName(String databaseName)

Database name for the endpoint.

Parameters:

databaseName - Database name for the endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

directPathParallelLoad

OracleSettings.Builder directPathParallelLoad(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

failTasksOnLobTruncation

OracleSettings.Builder failTasksOnLobTruncation(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

numberDatatypeScale

OracleSettings.Builder numberDatatypeScale(Integer 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

password

OracleSettings.Builder password(String password)

Endpoint connection password.

Parameters:

password - Endpoint connection password.

Returns:

Returns a reference to this object so that method calls can be chained together.

port

OracleSettings.Builder port(Integer port)

Endpoint TCP port.

Parameters:

port - Endpoint TCP port.

Returns:

Returns a reference to this object so that method calls can be chained together.

readTableSpaceName

OracleSettings.Builder readTableSpaceName(Boolean readTableSpaceName)

When set to true, this attribute supports tablespace replication.

Parameters:

readTableSpaceName - When set to true, this attribute supports tablespace replication.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryInterval

OracleSettings.Builder retryInterval(Integer retryInterval)

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

Example: retryInterval=6;

Parameters:

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

Example: retryInterval=6;

Returns:

Returns a reference to this object so that method calls can be chained together.

securityDbEncryption

OracleSettings.Builder securityDbEncryption(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityDbEncryptionName

OracleSettings.Builder securityDbEncryptionName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverName

OracleSettings.Builder serverName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

spatialDataOptionToGeoJsonFunctionName

OracleSettings.Builder spatialDataOptionToGeoJsonFunctionName(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

standbyDelayTime

OracleSettings.Builder standbyDelayTime(Integer 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

username

OracleSettings.Builder username(String username)

Endpoint connection user name.

Parameters:

username - Endpoint connection user name.

Returns:

Returns a reference to this object so that method calls can be chained together.

useBFile

OracleSettings.Builder useBFile(Boolean useBFile)

Set this attribute to Y to capture change data using the Binary Reader utility. Set UseLogminerReader to N to set this attribute to Y. 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.

Parameters:

useBFile - Set this attribute to Y to capture change data using the Binary Reader utility. Set UseLogminerReader to N to set this attribute to Y. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

useDirectPathFullLoad

OracleSettings.Builder useDirectPathFullLoad(Boolean useDirectPathFullLoad)

Set this attribute to Y 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.

Parameters:

useDirectPathFullLoad - Set this attribute to Y 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

useLogminerReader

OracleSettings.Builder useLogminerReader(Boolean useLogminerReader)

Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader to N, also set UseBfile to Y. 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.

Parameters:

useLogminerReader - Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). Set this attribute to N if you want to access the redo logs as a binary file. When you set UseLogminerReader to N, also set UseBfile to Y. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerAccessRoleArn

OracleSettings.Builder secretsManagerAccessRoleArn(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerSecretId

OracleSettings.Builder secretsManagerSecretId(String secretsManagerSecretId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerOracleAsmAccessRoleArn

OracleSettings.Builder secretsManagerOracleAsmAccessRoleArn(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

secretsManagerOracleAsmSecretId

OracleSettings.Builder secretsManagerOracleAsmSecretId(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

trimSpaceInChar

OracleSettings.Builder trimSpaceInChar(Boolean trimSpaceInChar)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

convertTimestampWithZoneToUTC

OracleSettings.Builder convertTimestampWithZoneToUTC(Boolean convertTimestampWithZoneToUTC)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

openTransactionWindow

OracleSettings.Builder openTransactionWindow(Integer 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. DMS supports a window of up to 9.5 hours including the value for OpenTransactionWindow.

Parameters:

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. DMS supports a window of up to 9.5 hours including the value for OpenTransactionWindow.

Returns:

Returns a reference to this object so that method calls can be chained together.