@Stability(value=Stable) @Internal public static final class CfnEndpoint.OracleSettingsProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnEndpoint.OracleSettingsProperty
CfnEndpoint.OracleSettingsPropertysoftware.amazon.jsii.JsiiObject.InitializationModeCfnEndpoint.OracleSettingsProperty.Builder, CfnEndpoint.OracleSettingsProperty.Jsii$Proxy| Modifier | Constructor and Description |
|---|---|
protected |
Jsii$Proxy(CfnEndpoint.OracleSettingsProperty.Builder builder)
Constructor that initializes the object based on literal property values passed by the
CfnEndpoint.DocDbSettingsProperty.Builder. |
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
| Modifier and Type | Method and Description |
|---|---|
com.fasterxml.jackson.databind.JsonNode |
$jsii$toJson() |
boolean |
equals(Object o) |
Object |
getAccessAlternateDirectly()
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.
|
Number |
getAdditionalArchivedLogDestId()
Set this attribute with `ArchivedLogDestId` in a primary/ standby setup.
|
Object |
getAddSupplementalLogging()
Set this attribute to set up table-level supplemental logging for the Oracle database.
|
Object |
getAllowSelectNestedTables()
Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types.
|
Number |
getArchivedLogDestId()
Specifies the ID of the destination for the archived redo logs.
|
Object |
getArchivedLogsOnly()
When this field is set to `Y` , AWS DMS only accesses the archived redo logs.
|
String |
getAsmPassword()
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
|
String |
getAsmServer()
For an Oracle source endpoint, your ASM server address.
|
String |
getAsmUser()
For an Oracle source endpoint, your ASM user name.
|
String |
getCharLengthSemantics()
Specifies whether the length of a character column is in bytes or in characters.
|
Object |
getDirectPathNoLog()
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.
|
Object |
getDirectPathParallelLoad()
When set to `true` , this attribute specifies a parallel load when `useDirectPathFullLoad` is set to `Y` .
|
Object |
getEnableHomogenousTablespace()
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
|
Object |
getExtraArchivedLogDestIds()
Specifies the IDs of one more destinations for one or more archived redo logs.
|
Object |
getFailTasksOnLobTruncation()
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` .
|
Number |
getNumberDatatypeScale()
Specifies the number scale.
|
String |
getOraclePathPrefix()
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.
|
Number |
getParallelAsmReadThreads()
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).
|
Number |
getReadAheadBlocks()
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).
|
Object |
getReadTableSpaceName()
When set to `true` , this attribute supports tablespace replication.
|
Object |
getReplacePathPrefix()
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.
|
Number |
getRetryInterval()
Specifies the number of seconds that the system waits before resending a query.
|
String |
getSecretsManagerAccessRoleArn()
The full Amazon Resource Name (ARN) of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the value in `SecretsManagerSecret` .
|
String |
getSecretsManagerOracleAsmAccessRoleArn()
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
|
String |
getSecretsManagerOracleAsmSecretId()
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
|
String |
getSecretsManagerSecretId()
The full ARN, partial ARN, or display name of the `SecretsManagerSecret` that contains the Oracle endpoint connection details.
|
String |
getSecurityDbEncryption()
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.
|
String |
getSecurityDbEncryptionName()
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.
|
String |
getSpatialDataOptionToGeoJsonFunctionName()
Use this attribute to convert `SDO_GEOMETRY` to `GEOJSON` format.
|
Number |
getStandbyDelayTime()
Use this attribute to specify a time in minutes for the delay in standby sync.
|
Object |
getUseAlternateFolderForOnline()
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.
|
Object |
getUseBFile()
Set this attribute to Y to capture change data using the Binary Reader utility.
|
Object |
getUseDirectPathFullLoad()
Set this attribute to Y to have AWS DMS use a direct path full load.
|
Object |
getUseLogminerReader()
Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default).
|
String |
getUsePathPrefix()
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.
|
int |
hashCode() |
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSetclone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitbuilderprotected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef - Reference to the JSII managed object.protected Jsii$Proxy(CfnEndpoint.OracleSettingsProperty.Builder builder)
CfnEndpoint.DocDbSettingsProperty.Builder.public final Object getAccessAlternateDirectly()
CfnEndpoint.OracleSettingsPropertyThis tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.
getAccessAlternateDirectly in interface CfnEndpoint.OracleSettingsPropertypublic final Number getAdditionalArchivedLogDestId()
CfnEndpoint.OracleSettingsPropertyThis attribute is useful in the case of a switchover. In this case, AWS 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 AWS 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 .
getAdditionalArchivedLogDestId in interface CfnEndpoint.OracleSettingsPropertypublic final Object getAddSupplementalLogging()
CfnEndpoint.OracleSettingsPropertyThis 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.
getAddSupplementalLogging in interface CfnEndpoint.OracleSettingsPropertypublic final Object getAllowSelectNestedTables()
CfnEndpoint.OracleSettingsPropertygetAllowSelectNestedTables in interface CfnEndpoint.OracleSettingsPropertypublic final Number getArchivedLogDestId()
CfnEndpoint.OracleSettingsProperty
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.
getArchivedLogDestId in interface CfnEndpoint.OracleSettingsPropertypublic final Object getArchivedLogsOnly()
CfnEndpoint.OracleSettingsPropertyIf the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges.
getArchivedLogsOnly in interface CfnEndpoint.OracleSettingsPropertypublic final String getAsmPassword()
CfnEndpoint.OracleSettingsProperty
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 .
getAsmPassword in interface CfnEndpoint.OracleSettingsPropertypublic final String getAsmServer()
CfnEndpoint.OracleSettingsProperty
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 .
getAsmServer in interface CfnEndpoint.OracleSettingsPropertypublic final String getAsmUser()
CfnEndpoint.OracleSettingsProperty
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 .
getAsmUser in interface CfnEndpoint.OracleSettingsPropertypublic final String getCharLengthSemantics()
CfnEndpoint.OracleSettingsProperty
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;
getCharLengthSemantics in interface CfnEndpoint.OracleSettingsPropertypublic final Object getDirectPathNoLog()
CfnEndpoint.OracleSettingsPropertygetDirectPathNoLog in interface CfnEndpoint.OracleSettingsPropertypublic final Object getDirectPathParallelLoad()
CfnEndpoint.OracleSettingsPropertyThis attribute also only applies when you use the AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
getDirectPathParallelLoad in interface CfnEndpoint.OracleSettingsPropertypublic final Object getEnableHomogenousTablespace()
CfnEndpoint.OracleSettingsPropertygetEnableHomogenousTablespace in interface CfnEndpoint.OracleSettingsPropertypublic final Object getExtraArchivedLogDestIds()
CfnEndpoint.OracleSettingsProperty
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, AWS DMS needs information about what destination to get archive redo logs from to read changes. AWS 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 AWS 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 .
getExtraArchivedLogDestIds in interface CfnEndpoint.OracleSettingsPropertypublic final Object getFailTasksOnLobTruncation()
CfnEndpoint.OracleSettingsProperty
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.
getFailTasksOnLobTruncation in interface CfnEndpoint.OracleSettingsPropertypublic final Number getNumberDatatypeScale()
CfnEndpoint.OracleSettingsPropertyYou 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
getNumberDatatypeScale in interface CfnEndpoint.OracleSettingsPropertypublic final String getOraclePathPrefix()
CfnEndpoint.OracleSettingsPropertyThis value specifies the default Oracle root used to access the redo logs.
getOraclePathPrefix in interface CfnEndpoint.OracleSettingsPropertypublic final Number getParallelAsmReadThreads()
CfnEndpoint.OracleSettingsProperty
You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
getParallelAsmReadThreads in interface CfnEndpoint.OracleSettingsPropertypublic final Number getReadAheadBlocks()
CfnEndpoint.OracleSettingsPropertyYou can specify an integer value between 1000 (the default) and 200,000 (the maximum).
getReadAheadBlocks in interface CfnEndpoint.OracleSettingsPropertypublic final Object getReadTableSpaceName()
CfnEndpoint.OracleSettingsPropertygetReadTableSpaceName in interface CfnEndpoint.OracleSettingsPropertypublic final Object getReplacePathPrefix()
CfnEndpoint.OracleSettingsProperty
This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix setting to access the redo logs.
getReplacePathPrefix in interface CfnEndpoint.OracleSettingsPropertypublic final Number getRetryInterval()
CfnEndpoint.OracleSettingsProperty
Example: retryInterval=6;
getRetryInterval in interface CfnEndpoint.OracleSettingsPropertypublic final String getSecretsManagerAccessRoleArn()
CfnEndpoint.OracleSettingsProperty
The role must allow the iam:PassRole action. SecretsManagerSecret has the value of the AWS 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 this
SecretsManagerSecret, the correspondingSecretsManagerAccessRoleArn, and theSecretsManagerSecretIdthat is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
getSecretsManagerAccessRoleArn in interface CfnEndpoint.OracleSettingsPropertypublic final String getSecretsManagerOracleAsmAccessRoleArn()
CfnEndpoint.OracleSettingsProperty
The full ARN of the IAM role that specifies AWS 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 forAsmUserName,AsmPassword, andAsmServerName. You can't specify both.For more information on creating this
SecretsManagerOracleAsmSecret, the correspondingSecretsManagerOracleAsmAccessRoleArn, and theSecretsManagerOracleAsmSecretIdthat is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
getSecretsManagerOracleAsmAccessRoleArn in interface CfnEndpoint.OracleSettingsPropertypublic final String getSecretsManagerOracleAsmSecretId()
CfnEndpoint.OracleSettingsProperty
The full ARN, partial ARN, or display name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.
getSecretsManagerOracleAsmSecretId in interface CfnEndpoint.OracleSettingsPropertypublic final String getSecretsManagerSecretId()
CfnEndpoint.OracleSettingsPropertygetSecretsManagerSecretId in interface CfnEndpoint.OracleSettingsPropertypublic final String getSecurityDbEncryption()
CfnEndpoint.OracleSettingsProperty
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 AWS DMS in the AWS Database Migration Service User Guide .
getSecurityDbEncryption in interface CfnEndpoint.OracleSettingsPropertypublic final String getSecurityDbEncryptionName()
CfnEndpoint.OracleSettingsProperty
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 AWS DMS in the AWS Database Migration Service User Guide .
getSecurityDbEncryptionName in interface CfnEndpoint.OracleSettingsPropertypublic final String getSpatialDataOptionToGeoJsonFunctionName()
CfnEndpoint.OracleSettingsProperty
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.
getSpatialDataOptionToGeoJsonFunctionName in interface CfnEndpoint.OracleSettingsPropertypublic final Number getStandbyDelayTime()
CfnEndpoint.OracleSettingsPropertyIf the source is an Oracle Active Data Guard standby database, use this attribute to specify the time lag between primary and standby databases.
In AWS 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.
getStandbyDelayTime in interface CfnEndpoint.OracleSettingsPropertypublic final Object getUseAlternateFolderForOnline()
CfnEndpoint.OracleSettingsPropertyThis tells the DMS instance to use any specified prefix replacement to access all online redo logs.
getUseAlternateFolderForOnline in interface CfnEndpoint.OracleSettingsPropertypublic final Object getUseBFile()
CfnEndpoint.OracleSettingsProperty
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 AWS DMS Binary Reader for CDC .
getUseBFile in interface CfnEndpoint.OracleSettingsPropertypublic final Object getUseDirectPathFullLoad()
CfnEndpoint.OracleSettingsPropertySpecify 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.
getUseDirectPathFullLoad in interface CfnEndpoint.OracleSettingsPropertypublic final Object getUseLogminerReader()
CfnEndpoint.OracleSettingsProperty
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 AWS DMS Binary Reader for CDC in the AWS DMS User Guide .
getUseLogminerReader in interface CfnEndpoint.OracleSettingsPropertypublic final String getUsePathPrefix()
CfnEndpoint.OracleSettingsPropertyThis value specifies the path prefix used to replace the default Oracle root to access the redo logs.
getUsePathPrefix in interface CfnEndpoint.OracleSettingsProperty@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
$jsii$toJson in interface software.amazon.jsii.JsiiSerializableCopyright © 2022. All rights reserved.