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.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.dms.CfnEndpoint.OracleSettingsProperty
CfnEndpoint.OracleSettingsProperty.Builder, CfnEndpoint.OracleSettingsProperty.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
Constructor that initializes the object based on literal property values passed by theCfnEndpoint.OracleSettingsProperty.Builder
.protected
Jsii$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.JsonNode
final boolean
final Object
Set this attribute tofalse
in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.final Number
Set this attribute withArchivedLogDestId
in a primary/ standby setup.final Object
Set this attribute to set up table-level supplemental logging for the Oracle database.final Object
Set this attribute totrue
to enable replication of Oracle tables containing columns that are nested tables or defined types.final Number
Specifies the ID of the destination for the archived redo logs.final Object
When this field is set toTrue
, AWS DMS only accesses the archived redo logs.final String
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.final String
For an Oracle source endpoint, your ASM server address.final String
For an Oracle source endpoint, your ASM user name.final String
Specifies whether the length of a character column is in bytes or in characters.final Object
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.final Object
When set totrue
, this attribute specifies a parallel load whenuseDirectPathFullLoad
is set toY
.final Object
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.final Object
Specifies the IDs of one more destinations for one or more archived redo logs.final Object
When set totrue
, this attribute causes a task to fail if the actual size of an LOB column is greater than the specifiedLobMaxSize
.final Number
Specifies the number scale.final String
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.final Number
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).final Number
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).final Object
When set totrue
, this attribute supports tablespace replication.final Object
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.final Number
Specifies the number of seconds that the system waits before resending a query.final String
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 inSecretsManagerSecret
.final String
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).final String
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).final String
The full ARN, partial ARN, or display name of theSecretsManagerSecret
that contains the Oracle endpoint connection details.final String
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.final String
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.final String
Use this attribute to convertSDO_GEOMETRY
toGEOJSON
format.final Number
Use this attribute to specify a time in minutes for the delay in standby sync.final Object
Set this attribute totrue
in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.final Object
Set this attribute to True to capture change data using the Binary Reader utility.final Object
Set this attribute to True to have AWS DMS use a direct path full load.final Object
Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).final String
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.final int
hashCode()
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.OracleSettingsProperty
Set this attribute tofalse
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.
- Specified by:
getAccessAlternateDirectly
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getAdditionalArchivedLogDestId
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set this attribute withArchivedLogDestId
in 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
RESETLOGS
option to open the database, never useRESETLOGS
unless necessary. For additional information aboutRESETLOGS
, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide .- Specified by:
getAdditionalArchivedLogDestId
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getAddSupplementalLogging
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.
- Specified by:
getAddSupplementalLogging
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getAllowSelectNestedTables
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set this attribute totrue
to enable replication of Oracle tables containing columns that are nested tables or defined types.- Specified by:
getAllowSelectNestedTables
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getArchivedLogDestId
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.- Specified by:
getArchivedLogDestId
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getArchivedLogsOnly
Description copied from interface:CfnEndpoint.OracleSettingsProperty
When 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.
- Specified by:
getArchivedLogsOnly
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getAsmPassword
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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 thePassword
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 .- Specified by:
getAsmPassword
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getAsmServer
Description copied from interface:CfnEndpoint.OracleSettingsProperty
For an Oracle source endpoint, your ASM server address.You can set this value from the
asm_server
value. You setasm_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 .- Specified by:
getAsmServer
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getAsmUser
Description copied from interface:CfnEndpoint.OracleSettingsProperty
For an Oracle source endpoint, your ASM user name.You can set this value from the
asm_user
value. You setasm_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 .- Specified by:
getAsmUser
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getCharLengthSemantics
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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;
- Specified by:
getCharLengthSemantics
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getDirectPathNoLog
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.- Specified by:
getDirectPathNoLog
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getDirectPathParallelLoad
Description copied from interface:CfnEndpoint.OracleSettingsProperty
When set totrue
, this attribute specifies a parallel load whenuseDirectPathFullLoad
is 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.
- Specified by:
getDirectPathParallelLoad
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getEnableHomogenousTablespace
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.- Specified by:
getEnableHomogenousTablespace
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getExtraArchivedLogDestIds
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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 thev$archived_log
view. Use this setting with thearchivedLogDestId
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 useRESETLOGS
unless it's necessary. For more information aboutRESETLOGS
, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide .- Specified by:
getExtraArchivedLogDestIds
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getFailTasksOnLobTruncation
Description copied from interface:CfnEndpoint.OracleSettingsProperty
When 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.- Specified by:
getFailTasksOnLobTruncation
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getNumberDatatypeScale
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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
- Specified by:
getNumberDatatypeScale
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getOraclePathPrefix
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.
- Specified by:
getOraclePathPrefix
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getParallelAsmReadThreads
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.- Specified by:
getParallelAsmReadThreads
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getReadAheadBlocks
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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).
- Specified by:
getReadAheadBlocks
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getReadTableSpaceName
Description copied from interface:CfnEndpoint.OracleSettingsProperty
When set totrue
, this attribute supports tablespace replication.- Specified by:
getReadTableSpaceName
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getReplacePathPrefix
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.- Specified by:
getReplacePathPrefix
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getRetryInterval
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Specifies the number of seconds that the system waits before resending a query.Example:
retryInterval=6;
- Specified by:
getRetryInterval
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSecretsManagerAccessRoleArn
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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 inSecretsManagerSecret
.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 theSecretsManagerSecretId
that 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:
getSecretsManagerAccessRoleArn
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSecretsManagerOracleAsmAccessRoleArn
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Required 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
. ThisSecretsManagerOracleAsmSecret
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 forAsmUser
,AsmPassword
, andAsmServerName
. You can't specify both.For more information on creating this
SecretsManagerOracleAsmSecret
, the correspondingSecretsManagerOracleAsmAccessRoleArn
, and theSecretsManagerOracleAsmSecretId
that 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:
getSecretsManagerOracleAsmAccessRoleArn
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSecretsManagerOracleAsmSecretId
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).The full ARN, partial ARN, or display name of the
SecretsManagerOracleAsmSecret
that contains the Oracle ASM connection details for the Oracle endpoint.- Specified by:
getSecretsManagerOracleAsmSecretId
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSecretsManagerSecretId
Description copied from interface:CfnEndpoint.OracleSettingsProperty
The full ARN, partial ARN, or display name of theSecretsManagerSecret
that contains the Oracle endpoint connection details.- Specified by:
getSecretsManagerSecretId
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSecurityDbEncryption
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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 thePassword
request parameter when you create the endpoint. TheSecurityDbEncryptian
setting is related to thisSecurityDbEncryptionName
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 .- Specified by:
getSecurityDbEncryption
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSecurityDbEncryptionName
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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 ofSecurityDbEncryptionName
, see the information and example for setting thesecurityDbEncryptionName
extra 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:
getSecurityDbEncryptionName
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getSpatialDataOptionToGeoJsonFunctionName
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Use this attribute to convertSDO_GEOMETRY
toGEOJSON
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 ofSDOGEOJSON
and setSpatialDataOptionToGeoJsonFunctionName
to call it instead.- Specified by:
getSpatialDataOptionToGeoJsonFunctionName
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getStandbyDelayTime
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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 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:
getStandbyDelayTime
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getUseAlternateFolderForOnline
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set this attribute totrue
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.
- Specified by:
getUseAlternateFolderForOnline
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getUseBFile
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set this attribute to True to capture change data using the Binary Reader utility.Set
UseLogminerReader
to False to set this attribute to True. To use Binary Reader with Amazon RDS for Oracle as the source, you set additional attributes. For more information about using this setting with Oracle Automatic Storage Management (ASM), see Using Oracle LogMiner or AWS DMS Binary Reader for CDC .- Specified by:
getUseBFile
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getUseDirectPathFullLoad
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set 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.
- Specified by:
getUseDirectPathFullLoad
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getUseLogminerReader
Description copied from interface:CfnEndpoint.OracleSettingsProperty
Set this attribute to True to capture change data using the Oracle LogMiner utility (the default).Set this attribute to False if you want to access the redo logs as a binary file. When you set
UseLogminerReader
to False, also setUseBfile
to 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 .- Specified by:
getUseLogminerReader
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
getUsePathPrefix
Description copied from interface:CfnEndpoint.OracleSettingsProperty
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.
- Specified by:
getUsePathPrefix
in interfaceCfnEndpoint.OracleSettingsProperty
- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJson
in interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-