Class CfnEndpoint.OracleSettingsProperty.Jsii$Proxy
- All Implemented Interfaces:
CfnEndpoint.OracleSettingsProperty,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnEndpoint.OracleSettingsProperty
CfnEndpoint.OracleSettingsProperty-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.OracleSettingsProperty
CfnEndpoint.OracleSettingsProperty.Builder, CfnEndpoint.OracleSettingsProperty.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedConstructor that initializes the object based on literal property values passed by theCfnEndpoint.OracleSettingsProperty.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal ObjectSet this attribute tofalsein order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.final NumberSet this attribute withArchivedLogDestIdin a primary/ standby setup.final ObjectSet this attribute to set up table-level supplemental logging for the Oracle database.final ObjectSet this attribute totrueto enable replication of Oracle tables containing columns that are nested tables or defined types.final NumberSpecifies the ID of the destination for the archived redo logs.final ObjectWhen this field is set toTrue, AWS DMS only accesses the archived redo logs.final StringFor an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.final StringFor an Oracle source endpoint, your ASM server address.final StringFor an Oracle source endpoint, your ASM user name.final StringSpecifies whether the length of a character column is in bytes or in characters.final ObjectWhen 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.final ObjectWhen set totrue, this attribute specifies a parallel load whenuseDirectPathFullLoadis set toY.final ObjectSet this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.final ObjectSpecifies the IDs of one more destinations for one or more archived redo logs.final ObjectWhen set totrue, this attribute causes a task to fail if the actual size of an LOB column is greater than the specifiedLobMaxSize.final NumberSpecifies the number scale.final StringSet 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.final NumberSet 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).final NumberSet 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).final ObjectWhen set totrue, this attribute supports tablespace replication.final ObjectSet this attribute to true in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.final NumberSpecifies the number of seconds that the system waits before resending a query.final StringThe 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 inSecretsManagerSecret.final StringRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM).final StringRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM).final StringThe full ARN, partial ARN, or display name of theSecretsManagerSecretthat contains the Oracle endpoint connection details.final StringFor 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.final StringFor 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.final StringUse this attribute to convertSDO_GEOMETRYtoGEOJSONformat.final NumberUse this attribute to specify a time in minutes for the delay in standby sync.final ObjectSet this attribute totruein order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.final ObjectSet this attribute to True to capture change data using the Binary Reader utility.final ObjectSet this attribute to True to have AWS DMS use a direct path full load.final ObjectSet this attribute to True to capture change data using the Oracle LogMiner utility (the default).final StringSet 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.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
Jsii$Proxy
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.- Parameters:
objRef- Reference to the JSII managed object.
-
Jsii$Proxy
Constructor that initializes the object based on literal property values passed by theCfnEndpoint.OracleSettingsProperty.Builder.
-
-
Method Details
-
getAccessAlternateDirectly
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet this attribute tofalsein 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 union: either
BooleanorIResolvable- Specified by:
getAccessAlternateDirectlyin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getAdditionalArchivedLogDestId
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet this attribute withArchivedLogDestIdin a primary/ standby setup.This 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
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 .- Specified by:
getAdditionalArchivedLogDestIdin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getAddSupplementalLogging
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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 union: either
BooleanorIResolvable- Specified by:
getAddSupplementalLoggingin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getAllowSelectNestedTables
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet this attribute totrueto enable replication of Oracle tables containing columns that are nested tables or defined types.Returns union: either
BooleanorIResolvable- Specified by:
getAllowSelectNestedTablesin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getArchivedLogDestId
Description copied from interface:CfnEndpoint.OracleSettingsPropertySpecifies 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.- Specified by:
getArchivedLogDestIdin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getArchivedLogsOnly
Description copied from interface:CfnEndpoint.OracleSettingsPropertyWhen this field is set toTrue, AWS DMS only accesses the archived redo logs.If the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS user account needs to be granted ASM privileges.
Returns union: either
BooleanorIResolvable- Specified by:
getArchivedLogsOnlyin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getAsmPassword
Description copied from interface:CfnEndpoint.OracleSettingsPropertyFor 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 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 .- Specified by:
getAsmPasswordin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getAsmServer
Description copied from interface:CfnEndpoint.OracleSettingsPropertyFor 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 .- Specified by:
getAsmServerin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getAsmUser
Description copied from interface:CfnEndpoint.OracleSettingsPropertyFor 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 .- Specified by:
getAsmUserin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getCharLengthSemantics
Description copied from interface:CfnEndpoint.OracleSettingsPropertySpecifies 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;- Specified by:
getCharLengthSemanticsin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getDirectPathNoLog
Description copied from interface:CfnEndpoint.OracleSettingsPropertyWhen 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.Returns union: either
BooleanorIResolvable- Specified by:
getDirectPathNoLogin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getDirectPathParallelLoad
Description copied from interface:CfnEndpoint.OracleSettingsPropertyWhen set totrue, this attribute specifies a parallel load whenuseDirectPathFullLoadis set toY.This attribute also only applies when you use the AWS DMS parallel load feature. Note that the target table cannot have any constraints or indexes.
Returns union: either
BooleanorIResolvable- Specified by:
getDirectPathParallelLoadin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getEnableHomogenousTablespace
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.Returns union: either
BooleanorIResolvable- Specified by:
getEnableHomogenousTablespacein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getExtraArchivedLogDestIds
Description copied from interface:CfnEndpoint.OracleSettingsPropertySpecifies 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, 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
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 .Returns union: either Listinvalid input: '<'
Number> orIResolvable- Specified by:
getExtraArchivedLogDestIdsin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getFailTasksOnLobTruncation
Description copied from interface:CfnEndpoint.OracleSettingsPropertyWhen set totrue, 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 union: either
BooleanorIResolvable- Specified by:
getFailTasksOnLobTruncationin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getNumberDatatypeScale
Description copied from interface:CfnEndpoint.OracleSettingsPropertySpecifies 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- Specified by:
getNumberDatatypeScalein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getOraclePathPrefix
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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.
- Specified by:
getOraclePathPrefixin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getParallelAsmReadThreads
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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.- Specified by:
getParallelAsmReadThreadsin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getReadAheadBlocks
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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).
- Specified by:
getReadAheadBlocksin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getReadTableSpaceName
Description copied from interface:CfnEndpoint.OracleSettingsPropertyWhen set totrue, this attribute supports tablespace replication.Returns union: either
BooleanorIResolvable- Specified by:
getReadTableSpaceNamein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getReplacePathPrefix
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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 union: either
BooleanorIResolvable- Specified by:
getReplacePathPrefixin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getRetryInterval
Description copied from interface:CfnEndpoint.OracleSettingsPropertySpecifies the number of seconds that the system waits before resending a query.Example:
retryInterval=6;- Specified by:
getRetryIntervalin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSecretsManagerAccessRoleArn
Description copied from interface:CfnEndpoint.OracleSettingsPropertyThe 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 inSecretsManagerSecret.The role must allow the
iam:PassRoleaction.SecretsManagerSecrethas 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 .- Specified by:
getSecretsManagerAccessRoleArnin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSecretsManagerOracleAsmAccessRoleArn
Description copied from interface:CfnEndpoint.OracleSettingsPropertyRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM).The full ARN of the IAM role that specifies AWS 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 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 .- Specified by:
getSecretsManagerOracleAsmAccessRoleArnin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSecretsManagerOracleAsmSecretId
Description copied from interface:CfnEndpoint.OracleSettingsPropertyRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM).The full ARN, partial ARN, or display name of the
SecretsManagerOracleAsmSecretthat contains the Oracle ASM connection details for the Oracle endpoint.- Specified by:
getSecretsManagerOracleAsmSecretIdin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSecretsManagerSecretId
Description copied from interface:CfnEndpoint.OracleSettingsPropertyThe full ARN, partial ARN, or display name of theSecretsManagerSecretthat contains the Oracle endpoint connection details.- Specified by:
getSecretsManagerSecretIdin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSecurityDbEncryption
Description copied from interface:CfnEndpoint.OracleSettingsPropertyFor 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 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 AWS DMS in the AWS Database Migration Service User Guide .- Specified by:
getSecurityDbEncryptionin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSecurityDbEncryptionName
Description copied from interface:CfnEndpoint.OracleSettingsPropertyFor 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 AWS DMS in the AWS Database Migration Service User Guide .- Specified by:
getSecurityDbEncryptionNamein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getSpatialDataOptionToGeoJsonFunctionName
Description copied from interface:CfnEndpoint.OracleSettingsPropertyUse this attribute to convertSDO_GEOMETRYtoGEOJSONformat.By default, DMS calls the
SDO2GEOJSONcustom function if present and accessible. Or you can create your own custom function that mimics the operation ofSDOGEOJSONand setSpatialDataOptionToGeoJsonFunctionNameto call it instead.- Specified by:
getSpatialDataOptionToGeoJsonFunctionNamein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getStandbyDelayTime
Description copied from interface:CfnEndpoint.OracleSettingsPropertyUse 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 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.
- Specified by:
getStandbyDelayTimein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getUseAlternateFolderForOnline
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet this attribute totruein 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 union: either
BooleanorIResolvable- Specified by:
getUseAlternateFolderForOnlinein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getUseBFile
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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 AWS DMS Binary Reader for CDC .Returns union: either
BooleanorIResolvable- Specified by:
getUseBFilein interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getUseDirectPathFullLoad
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet this attribute to True to have AWS 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 union: either
BooleanorIResolvable- Specified by:
getUseDirectPathFullLoadin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getUseLogminerReader
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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 AWS DMS Binary Reader for CDC in the AWS DMS User Guide .Returns union: either
BooleanorIResolvable- Specified by:
getUseLogminerReaderin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
getUsePathPrefix
Description copied from interface:CfnEndpoint.OracleSettingsPropertySet 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.
- Specified by:
getUsePathPrefixin interfaceCfnEndpoint.OracleSettingsProperty- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-