Class OracleSettings
- java.lang.Object
-
- software.amazon.awssdk.services.databasemigration.model.OracleSettings
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<OracleSettings.Builder,OracleSettings>
@Generated("software.amazon.awssdk:codegen") public final class OracleSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OracleSettings.Builder,OracleSettings>
Provides information that defines an Oracle endpoint.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceOracleSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanaccessAlternateDirectly()Set this attribute tofalsein order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.IntegeradditionalArchivedLogDestId()Set this attribute withArchivedLogDestIdin a primary/ standby setup.BooleanaddSupplementalLogging()Set this attribute to set up table-level supplemental logging for the Oracle database.BooleanallowSelectNestedTables()Set this attribute totrueto enable replication of Oracle tables containing columns that are nested tables or defined types.IntegerarchivedLogDestId()Specifies the ID of the destination for the archived redo logs.BooleanarchivedLogsOnly()When this field is set toTrue, DMS only accesses the archived redo logs.StringasmPassword()For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.StringasmServer()For an Oracle source endpoint, your ASM server address.StringasmUser()For an Oracle source endpoint, your ASM user name.OracleAuthenticationMethodauthenticationMethod()Specifies the authentication method to be used with Oracle.StringauthenticationMethodAsString()Specifies the authentication method to be used with Oracle.static OracleSettings.Builderbuilder()CharLengthSemanticscharLengthSemantics()Specifies whether the length of a character column is in bytes or in characters.StringcharLengthSemanticsAsString()Specifies whether the length of a character column is in bytes or in characters.BooleanconvertTimestampWithZoneToUTC()When true, converts timestamps with thetimezonedatatype to their UTC value.StringdatabaseName()Database name for the endpoint.BooleandirectPathNoLog()When set totrue, 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.BooleandirectPathParallelLoad()When set totrue, this attribute specifies a parallel load whenuseDirectPathFullLoadis set toY.BooleanenableHomogenousTablespace()Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Integer>extraArchivedLogDestIds()Specifies the IDs of one more destinations for one or more archived redo logs.BooleanfailTasksOnLobTruncation()When set totrue, this attribute causes a task to fail if the actual size of an LOB column is greater than the specifiedLobMaxSize.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasExtraArchivedLogDestIds()For responses, this returns true if the service returned a value for the ExtraArchivedLogDestIds property.inthashCode()IntegernumberDatatypeScale()Specifies the number scale.IntegeropenTransactionWindow()The timeframe in minutes to check for open transactions for a CDC-only task.StringoraclePathPrefix()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.IntegerparallelAsmReadThreads()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).Stringpassword()Endpoint connection password.Integerport()Endpoint TCP port.IntegerreadAheadBlocks()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).BooleanreadTableSpaceName()When set totrue, this attribute supports tablespace replication.BooleanreplacePathPrefix()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.IntegerretryInterval()Specifies the number of seconds that the system waits before resending a query.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsecretsManagerAccessRoleArn()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 inSecretsManagerSecret.StringsecretsManagerOracleAsmAccessRoleArn()Required only if your Oracle endpoint uses Automatic Storage Management (ASM).StringsecretsManagerOracleAsmSecretId()Required only if your Oracle endpoint uses Automatic Storage Management (ASM).StringsecretsManagerSecretId()The full ARN, partial ARN, or friendly name of theSecretsManagerSecretthat contains the Oracle endpoint connection details.StringsecurityDbEncryption()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.StringsecurityDbEncryptionName()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.static Class<? extends OracleSettings.Builder>serializableBuilderClass()StringserverName()Fully qualified domain name of the endpoint.StringspatialDataOptionToGeoJsonFunctionName()Use this attribute to convertSDO_GEOMETRYtoGEOJSONformat.IntegerstandbyDelayTime()Use this attribute to specify a time in minutes for the delay in standby sync.OracleSettings.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleantrimSpaceInChar()Use theTrimSpaceInCharsource endpoint setting to trim data on CHAR and NCHAR data types during migration.BooleanuseAlternateFolderForOnline()Set this attribute totruein order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.BooleanuseBFile()Set this attribute to True to capture change data using the Binary Reader utility.BooleanuseDirectPathFullLoad()Set this attribute to True to have DMS use a direct path full load.BooleanuseLogminerReader()Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).StringusePathPrefix()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.Stringusername()Endpoint connection user name.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
addSupplementalLogging
public final 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.
- Returns:
- 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.
-
archivedLogDestId
public final 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
AdditionalArchivedLogDestIdoption to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.- Returns:
- 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
AdditionalArchivedLogDestIdoption to specify the additional destination ID. Doing this improves performance by ensuring that the correct logs are accessed from the outset.
-
additionalArchivedLogDestId
public final Integer additionalArchivedLogDestId()
Set this attribute with
ArchivedLogDestIdin 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
RESETLOGSoption to open the database, never useRESETLOGSunless necessary. For additional information aboutRESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.- Returns:
- Set this attribute with
ArchivedLogDestIdin 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
RESETLOGSoption to open the database, never useRESETLOGSunless necessary. For additional information aboutRESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
-
hasExtraArchivedLogDestIds
public final boolean hasExtraArchivedLogDestIds()
For responses, this returns true if the service returned a value for the ExtraArchivedLogDestIds property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
extraArchivedLogDestIds
public final List<Integer> extraArchivedLogDestIds()
Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the
dest_idcolumn in thev$archived_logview. Use this setting with thearchivedLogDestIdextra 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
RESETLOGSoption to open the database, never useRESETLOGSunless it's necessary. For more information aboutRESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasExtraArchivedLogDestIds()method.- Returns:
- Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values
of the
dest_idcolumn in thev$archived_logview. Use this setting with thearchivedLogDestIdextra 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
RESETLOGSoption to open the database, never useRESETLOGSunless it's necessary. For more information aboutRESETLOGS, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide.
-
allowSelectNestedTables
public final Boolean allowSelectNestedTables()
Set this attribute to
trueto enable replication of Oracle tables containing columns that are nested tables or defined types.- Returns:
- Set this attribute to
trueto enable replication of Oracle tables containing columns that are nested tables or defined types.
-
parallelAsmReadThreads
public final 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
readAheadBlocksattribute.- Returns:
- 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
readAheadBlocksattribute.
-
readAheadBlocks
public final 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).
- Returns:
- 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).
-
accessAlternateDirectly
public final Boolean accessAlternateDirectly()
Set this attribute to
falsein 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:
- Set this attribute to
falsein 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.
-
useAlternateFolderForOnline
public final Boolean useAlternateFolderForOnline()
Set this attribute to
truein 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:
- Set this attribute to
truein 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.
-
oraclePathPrefix
public final 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.
- Returns:
- 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.
-
usePathPrefix
public final 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.
- Returns:
- 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.
-
replacePathPrefix
public final 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
usePathPrefixsetting to access the redo logs.- Returns:
- 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
usePathPrefixsetting to access the redo logs.
-
enableHomogenousTablespace
public final Boolean enableHomogenousTablespace()
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
- Returns:
- Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
-
directPathNoLog
public final 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.- Returns:
- 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.
-
archivedLogsOnly
public final Boolean 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.- Returns:
- 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.
-
asmPassword
public final String asmPassword()
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this value from the
asm_user_passwordvalue. You set this value as part of the comma-separated value that you set to thePasswordrequest 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:
- For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. You can set this
value from the
asm_user_passwordvalue. You set this value as part of the comma-separated value that you set to thePasswordrequest 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.
-
asmServer
public final String asmServer()
For an Oracle source endpoint, your ASM server address. You can set this value from the
asm_servervalue. You setasm_serveras 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:
- For an Oracle source endpoint, your ASM server address. You can set this value from the
asm_servervalue. You setasm_serveras 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.
-
asmUser
public final String asmUser()
For an Oracle source endpoint, your ASM user name. You can set this value from the
asm_uservalue. You setasm_useras 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:
- For an Oracle source endpoint, your ASM user name. You can set this value from the
asm_uservalue. You setasm_useras 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.
-
charLengthSemantics
public final 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;If the service returns an enum value that is not available in the current SDK version,
charLengthSemanticswill returnCharLengthSemantics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcharLengthSemanticsAsString().- Returns:
- 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; - See Also:
CharLengthSemantics
-
charLengthSemanticsAsString
public final String charLengthSemanticsAsString()
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;If the service returns an enum value that is not available in the current SDK version,
charLengthSemanticswill returnCharLengthSemantics.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcharLengthSemanticsAsString().- Returns:
- 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; - See Also:
CharLengthSemantics
-
databaseName
public final String databaseName()
Database name for the endpoint.
- Returns:
- Database name for the endpoint.
-
directPathParallelLoad
public final Boolean directPathParallelLoad()
When set to
true, this attribute specifies a parallel load whenuseDirectPathFullLoadis set toY. 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:
- When set to
true, this attribute specifies a parallel load whenuseDirectPathFullLoadis set toY. This attribute also only applies when you use the DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
-
failTasksOnLobTruncation
public final 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 specifiedLobMaxSize.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:
- When set to
true, this attribute causes a task to fail if the actual size of an LOB column is greater than the specifiedLobMaxSize.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.
-
numberDatatypeScale
public final 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- Returns:
- 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
-
password
public final String password()
Endpoint connection password.
- Returns:
- Endpoint connection password.
-
port
public final Integer port()
Endpoint TCP port.
- Returns:
- Endpoint TCP port.
-
readTableSpaceName
public final Boolean readTableSpaceName()
When set to
true, this attribute supports tablespace replication.- Returns:
- When set to
true, this attribute supports tablespace replication.
-
retryInterval
public final Integer retryInterval()
Specifies the number of seconds that the system waits before resending a query.
Example:
retryInterval=6;- Returns:
- Specifies the number of seconds that the system waits before resending a query.
Example:
retryInterval=6;
-
securityDbEncryption
public final 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_Passwordpart of the comma-separated value you set to thePasswordrequest parameter when you create the endpoint. TheSecurityDbEncryptiansetting is related to thisSecurityDbEncryptionNamesetting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.- Returns:
- 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_Passwordpart of the comma-separated value you set to thePasswordrequest parameter when you create the endpoint. TheSecurityDbEncryptiansetting is related to thisSecurityDbEncryptionNamesetting. For more information, see Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.
-
securityDbEncryptionName
public final 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
SecurityDbEncryptionsetting. For more information on setting the key name value ofSecurityDbEncryptionName, see the information and example for setting thesecurityDbEncryptionNameextra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.- Returns:
- 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
SecurityDbEncryptionsetting. For more information on setting the key name value ofSecurityDbEncryptionName, see the information and example for setting thesecurityDbEncryptionNameextra connection attribute in Supported encryption methods for using Oracle as a source for DMS in the Database Migration Service User Guide.
-
serverName
public final String serverName()
Fully qualified domain name of the endpoint.
For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
Endpoint.Addressfield.- Returns:
- Fully qualified domain name of the endpoint.
For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the
Endpoint.Addressfield.
-
spatialDataOptionToGeoJsonFunctionName
public final String spatialDataOptionToGeoJsonFunctionName()
Use this attribute to convert
SDO_GEOMETRYtoGEOJSONformat. By default, DMS calls theSDO2GEOJSONcustom function if present and accessible. Or you can create your own custom function that mimics the operation ofSDOGEOJSONand setSpatialDataOptionToGeoJsonFunctionNameto call it instead.- Returns:
- Use this attribute to convert
SDO_GEOMETRYtoGEOJSONformat. By default, DMS calls theSDO2GEOJSONcustom function if present and accessible. Or you can create your own custom function that mimics the operation ofSDOGEOJSONand setSpatialDataOptionToGeoJsonFunctionNameto call it instead.
-
standbyDelayTime
public final 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.
- Returns:
- 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.
-
username
public final String username()
Endpoint connection user name.
- Returns:
- Endpoint connection user name.
-
useBFile
public final Boolean useBFile()
Set this attribute to True to capture change data using the Binary Reader utility. Set
UseLogminerReaderto 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.- Returns:
- Set this attribute to True to capture change data using the Binary Reader utility. Set
UseLogminerReaderto 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.
-
useDirectPathFullLoad
public final Boolean 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.
- Returns:
- 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.
-
useLogminerReader
public final Boolean 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
UseLogminerReaderto False, also setUseBfileto 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.- Returns:
- 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
UseLogminerReaderto False, also setUseBfileto 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.
-
secretsManagerAccessRoleArn
public final 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 theiam:PassRoleaction.SecretsManagerSecrethas 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 forUserName,Password,ServerName, andPort. You can't specify both. For more information on creating thisSecretsManagerSecretand theSecretsManagerAccessRoleArnandSecretsManagerSecretIdrequired to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.- Returns:
- 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 theiam:PassRoleaction.SecretsManagerSecrethas 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 forUserName,Password,ServerName, andPort. You can't specify both. For more information on creating thisSecretsManagerSecretand theSecretsManagerAccessRoleArnandSecretsManagerSecretIdrequired to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
-
secretsManagerSecretId
public final String secretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecretthat contains the Oracle endpoint connection details.- Returns:
- The full ARN, partial ARN, or friendly name of the
SecretsManagerSecretthat contains the Oracle endpoint connection details.
-
secretsManagerOracleAsmAccessRoleArn
public final 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. ThisSecretsManagerOracleAsmSecrethas 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 forAsmUser,AsmPassword, andAsmServerName. You can't specify both. For more information on creating thisSecretsManagerOracleAsmSecretand theSecretsManagerOracleAsmAccessRoleArnandSecretsManagerOracleAsmSecretIdrequired to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.- Returns:
- 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. ThisSecretsManagerOracleAsmSecrethas 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 forAsmUser,AsmPassword, andAsmServerName. You can't specify both. For more information on creating thisSecretsManagerOracleAsmSecretand theSecretsManagerOracleAsmAccessRoleArnandSecretsManagerOracleAsmSecretIdrequired to access it, see Using secrets to access Database Migration Service resources in the Database Migration Service User Guide.
-
secretsManagerOracleAsmSecretId
public final String secretsManagerOracleAsmSecretId()
Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the
SecretsManagerOracleAsmSecretthat contains the Oracle ASM connection details for the Oracle endpoint.- Returns:
- Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN,
or friendly name of the
SecretsManagerOracleAsmSecretthat contains the Oracle ASM connection details for the Oracle endpoint.
-
trimSpaceInChar
public final Boolean trimSpaceInChar()
Use the
TrimSpaceInCharsource endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value istrue.- Returns:
- Use the
TrimSpaceInCharsource endpoint setting to trim data on CHAR and NCHAR data types during migration. The default value istrue.
-
convertTimestampWithZoneToUTC
public final Boolean convertTimestampWithZoneToUTC()
When true, converts timestamps with the
timezonedatatype to their UTC value.- Returns:
- When true, converts timestamps with the
timezonedatatype to their UTC value.
-
openTransactionWindow
public final 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.
- Returns:
- 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.
-
authenticationMethod
public final OracleAuthenticationMethod authenticationMethod()
Specifies the authentication method to be used with Oracle.
If the service returns an enum value that is not available in the current SDK version,
authenticationMethodwill returnOracleAuthenticationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationMethodAsString().- Returns:
- Specifies the authentication method to be used with Oracle.
- See Also:
OracleAuthenticationMethod
-
authenticationMethodAsString
public final String authenticationMethodAsString()
Specifies the authentication method to be used with Oracle.
If the service returns an enum value that is not available in the current SDK version,
authenticationMethodwill returnOracleAuthenticationMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromauthenticationMethodAsString().- Returns:
- Specifies the authentication method to be used with Oracle.
- See Also:
OracleAuthenticationMethod
-
toBuilder
public OracleSettings.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<OracleSettings.Builder,OracleSettings>
-
builder
public static OracleSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends OracleSettings.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-