Class CfnEndpoint.OracleSettingsProperty
Provides information that defines an Oracle endpoint.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class OracleSettingsProperty : Object, CfnEndpoint.IOracleSettingsProperty
Syntax (vb)
Public Class OracleSettingsProperty
Inherits Object
Implements CfnEndpoint.IOracleSettingsProperty
Remarks
This information includes the output format of records applied to the endpoint and details of transaction and control table data information. For information about other available settings, see Extra connection attributes when using Oracle as a source for AWS DMS and Extra connection attributes when using Oracle as a target for AWS DMS in the AWS Database Migration Service User Guide .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.DMS;
var oracleSettingsProperty = new OracleSettingsProperty {
AccessAlternateDirectly = false,
AdditionalArchivedLogDestId = 123,
AddSupplementalLogging = false,
AllowSelectNestedTables = false,
ArchivedLogDestId = 123,
ArchivedLogsOnly = false,
AsmPassword = "asmPassword",
AsmServer = "asmServer",
AsmUser = "asmUser",
CharLengthSemantics = "charLengthSemantics",
DirectPathNoLog = false,
DirectPathParallelLoad = false,
EnableHomogenousTablespace = false,
ExtraArchivedLogDestIds = new [] { 123 },
FailTasksOnLobTruncation = false,
NumberDatatypeScale = 123,
OraclePathPrefix = "oraclePathPrefix",
ParallelAsmReadThreads = 123,
ReadAheadBlocks = 123,
ReadTableSpaceName = false,
ReplacePathPrefix = false,
RetryInterval = 123,
SecretsManagerAccessRoleArn = "secretsManagerAccessRoleArn",
SecretsManagerOracleAsmAccessRoleArn = "secretsManagerOracleAsmAccessRoleArn",
SecretsManagerOracleAsmSecretId = "secretsManagerOracleAsmSecretId",
SecretsManagerSecretId = "secretsManagerSecretId",
SecurityDbEncryption = "securityDbEncryption",
SecurityDbEncryptionName = "securityDbEncryptionName",
SpatialDataOptionToGeoJsonFunctionName = "spatialDataOptionToGeoJsonFunctionName",
StandbyDelayTime = 123,
UseAlternateFolderForOnline = false,
UseBFile = false,
UseDirectPathFullLoad = false,
UseLogminerReader = false,
UsePathPrefix = "usePathPrefix"
};
Synopsis
Constructors
OracleSettingsProperty() |
Properties
AccessAlternateDirectly | Set this attribute to |
AdditionalArchivedLogDestId | Set this attribute with |
AddSupplementalLogging | Set this attribute to set up table-level supplemental logging for the Oracle database. |
AllowSelectNestedTables | Set this attribute to |
ArchivedLogDestId | Specifies the ID of the destination for the archived redo logs. |
ArchivedLogsOnly | When this field is set to |
AsmPassword | For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password. |
AsmServer | For an Oracle source endpoint, your ASM server address. |
AsmUser | For an Oracle source endpoint, your ASM user name. |
CharLengthSemantics | Specifies whether the length of a character column is in bytes or in characters. |
DirectPathNoLog | When set to |
DirectPathParallelLoad | When set to |
EnableHomogenousTablespace | Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target. |
ExtraArchivedLogDestIds | Specifies the IDs of one more destinations for one or more archived redo logs. |
FailTasksOnLobTruncation | When set to |
NumberDatatypeScale | Specifies the number scale. |
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. |
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). |
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). |
ReadTableSpaceName | When set to |
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. |
RetryInterval | Specifies the number of seconds that the system waits before resending a query. |
SecretsManagerAccessRoleArn | 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 |
SecretsManagerOracleAsmAccessRoleArn | Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). |
SecretsManagerOracleAsmSecretId | Required only if your Oracle endpoint uses Advanced Storage Manager (ASM). |
SecretsManagerSecretId | The full ARN, partial ARN, or display name of the |
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. |
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. |
SpatialDataOptionToGeoJsonFunctionName | Use this attribute to convert |
StandbyDelayTime | Use this attribute to specify a time in minutes for the delay in standby sync. |
UseAlternateFolderForOnline | Set this attribute to |
UseBFile | Set this attribute to Y to capture change data using the Binary Reader utility. |
UseDirectPathFullLoad | Set this attribute to Y to have AWS DMS use a direct path full load. |
UseLogminerReader | Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default). |
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. |
Constructors
OracleSettingsProperty()
public OracleSettingsProperty()
Properties
AccessAlternateDirectly
Set this attribute to false
in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
public object AccessAlternateDirectly { get; set; }
Property Value
System.Object
Remarks
This tells the DMS instance to not access redo logs through any specified path prefix replacement using direct file access.
AdditionalArchivedLogDestId
Set this attribute with ArchivedLogDestId
in a primary/ standby setup.
public Nullable<double> AdditionalArchivedLogDestId { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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 use RESETLOGS
unless necessary. For additional information about RESETLOGS
, see RMAN Data Repair Concepts in the Oracle Database Backup and Recovery User's Guide .
AddSupplementalLogging
Set this attribute to set up table-level supplemental logging for the Oracle database.
public object AddSupplementalLogging { get; set; }
Property Value
System.Object
Remarks
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.
AllowSelectNestedTables
Set this attribute to true
to enable replication of Oracle tables containing columns that are nested tables or defined types.
public object AllowSelectNestedTables { get; set; }
Property Value
System.Object
Remarks
ArchivedLogDestId
Specifies the ID of the destination for the archived redo logs.
public Nullable<double> ArchivedLogDestId { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
ArchivedLogsOnly
When this field is set to Y
, AWS DMS only accesses the archived redo logs.
public object ArchivedLogsOnly { get; set; }
Property Value
System.Object
Remarks
If the archived redo logs are stored on Automatic Storage Management (ASM) only, the AWS DMS user account needs to be granted ASM privileges.
AsmPassword
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
public string AsmPassword { get; set; }
Property Value
System.String
Remarks
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 .
AsmServer
For an Oracle source endpoint, your ASM server address.
public string AsmServer { get; set; }
Property Value
System.String
Remarks
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 .
AsmUser
For an Oracle source endpoint, your ASM user name.
public string AsmUser { get; set; }
Property Value
System.String
Remarks
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 .
CharLengthSemantics
Specifies whether the length of a character column is in bytes or in characters.
public string CharLengthSemantics { get; set; }
Property Value
System.String
Remarks
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;
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.
public object DirectPathNoLog { get; set; }
Property Value
System.Object
Remarks
DirectPathParallelLoad
When set to true
, this attribute specifies a parallel load when useDirectPathFullLoad
is set to Y
.
public object DirectPathParallelLoad { get; set; }
Property Value
System.Object
Remarks
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.
EnableHomogenousTablespace
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
public object EnableHomogenousTablespace { get; set; }
Property Value
System.Object
Remarks
ExtraArchivedLogDestIds
Specifies the IDs of one more destinations for one or more archived redo logs.
public object ExtraArchivedLogDestIds { get; set; }
Property Value
System.Object
Remarks
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 .
FailTasksOnLobTruncation
When set to true
, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified LobMaxSize
.
public object FailTasksOnLobTruncation { get; set; }
Property Value
System.Object
Remarks
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
Specifies the number scale.
public Nullable<double> NumberDatatypeScale { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
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.
public string OraclePathPrefix { get; set; }
Property Value
System.String
Remarks
This value specifies the default Oracle root used to access the redo logs.
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).
public Nullable<double> ParallelAsmReadThreads { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You can specify an integer value between 2 (the default) and 8 (the maximum). Use this attribute together with the readAheadBlocks
attribute.
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).
public Nullable<double> ReadAheadBlocks { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
ReadTableSpaceName
When set to true
, this attribute supports tablespace replication.
public object ReadTableSpaceName { get; set; }
Property Value
System.Object
Remarks
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.
public object ReplacePathPrefix { get; set; }
Property Value
System.Object
Remarks
This setting tells DMS instance to replace the default Oracle root with the specified usePathPrefix
setting to access the redo logs.
RetryInterval
Specifies the number of seconds that the system waits before resending a query.
public Nullable<double> RetryInterval { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
SecretsManagerAccessRoleArn
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
.
public string SecretsManagerAccessRoleArn { get; set; }
Property Value
System.String
Remarks
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 for UserName
, Password
, ServerName
, and Port
. You can't specify both.
For more information on creating this SecretsManagerSecret
, the corresponding SecretsManagerAccessRoleArn
, and the SecretsManagerSecretId
that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerOracleAsmAccessRoleArn
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
public string SecretsManagerOracleAsmAccessRoleArn { get; set; }
Property Value
System.String
Remarks
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 for AsmUser
, AsmPassword
, and AsmServerName
. You can't specify both.
For more information on creating this SecretsManagerOracleAsmSecret
, the corresponding SecretsManagerOracleAsmAccessRoleArn
, and the SecretsManagerOracleAsmSecretId
that is required to access it, see Using secrets to access AWS Database Migration Service resources in the AWS Database Migration Service User Guide .
SecretsManagerOracleAsmSecretId
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
public string SecretsManagerOracleAsmSecretId { get; set; }
Property Value
System.String
Remarks
The full ARN, partial ARN, or display name of the SecretsManagerOracleAsmSecret
that contains the Oracle ASM connection details for the Oracle endpoint.
SecretsManagerSecretId
The full ARN, partial ARN, or display name of the SecretsManagerSecret
that contains the Oracle endpoint connection details.
public string SecretsManagerSecretId { get; set; }
Property Value
System.String
Remarks
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.
public string SecurityDbEncryption { get; set; }
Property Value
System.String
Remarks
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 .
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.
public string SecurityDbEncryptionName { get; set; }
Property Value
System.String
Remarks
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 .
SpatialDataOptionToGeoJsonFunctionName
Use this attribute to convert SDO_GEOMETRY
to GEOJSON
format.
public string SpatialDataOptionToGeoJsonFunctionName { get; set; }
Property Value
System.String
Remarks
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.
StandbyDelayTime
Use this attribute to specify a time in minutes for the delay in standby sync.
public Nullable<double> StandbyDelayTime { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
UseAlternateFolderForOnline
Set this attribute to true
in order to use the Binary Reader to capture change data for an Amazon RDS for Oracle as the source.
public object UseAlternateFolderForOnline { get; set; }
Property Value
System.Object
Remarks
This tells the DMS instance to use any specified prefix replacement to access all online redo logs.
UseBFile
Set this attribute to Y to capture change data using the Binary Reader utility.
public object UseBFile { get; set; }
Property Value
System.Object
Remarks
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 .
UseDirectPathFullLoad
Set this attribute to Y to have AWS DMS use a direct path full load.
public object UseDirectPathFullLoad { get; set; }
Property Value
System.Object
Remarks
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
Set this attribute to Y to capture change data using the Oracle LogMiner utility (the default).
public object UseLogminerReader { get; set; }
Property Value
System.Object
Remarks
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 .
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.
public string UsePathPrefix { get; set; }
Property Value
System.String
Remarks
This value specifies the path prefix used to replace the default Oracle root to access the redo logs.