![]() |
![]()
| ![]() |
![]()
NAMEPaws::DMS::OracleSettings USAGEThis class represents one of two things: Arguments in a call to a service Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object. As an example, if Att1 is expected to be a Paws::DMS::OracleSettings object: $service_obj->Method(Att1 => { AccessAlternateDirectly => $value, ..., Username => $value }); Results returned from an API call Use accessors for each attribute. If Att1 is expected to be an Paws::DMS::OracleSettings object: $result = $service_obj->Method(...); $result->Att1->AccessAlternateDirectly DESCRIPTIONProvides information that defines an Oracle endpoint. ATTRIBUTESAccessAlternateDirectly => BoolSet this attribute to "false" 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. AdditionalArchivedLogDestId => IntSet this attribute with "archivedLogDestId" 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. AddSupplementalLogging => BoolSet 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. AllowSelectNestedTables => BoolSet this attribute to "true" to enable replication of Oracle tables containing columns that are nested tables or defined types. ArchivedLogDestId => IntSpecifies the destination of the archived redo logs. The value should be the same as the DEST_ID number in the v$archived_log table. When working with multiple log destinations (DEST_ID), we recommend that you to specify an archived redo logs location identifier. Doing this improves performance by ensuring that the correct logs are accessed from the outset. ArchivedLogsOnly => BoolWhen this field is set to "Y", AWS DMS only accesses the archived redo logs. If the archived redo logs are stored on Oracle ASM only, the AWS DMS user account needs to be granted ASM privileges. AsmPassword => StrFor 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 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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). AsmServer => StrFor an Oracle source endpoint, your ASM server address. 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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). AsmUser => StrFor an Oracle source endpoint, your ASM user name. 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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.CDC.Configuration). CharLengthSemantics => StrSpecifies 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;" DatabaseName => StrDatabase name for the endpoint. DirectPathNoLog => BoolWhen 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. DirectPathParallelLoad => BoolWhen set to "true", this attribute specifies a parallel load when "useDirectPathFullLoad" is set to "Y". 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 => BoolSet this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target. FailTasksOnLobTruncation => BoolWhen set to "true", this attribute causes a task to fail if the actual size of an LOB column is greater than the specified "LobMaxSize". 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 => IntSpecifies 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" OraclePathPrefix => StrSet 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. ParallelAsmReadThreads => IntSet 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. Password => StrEndpoint connection password. Port => IntEndpoint TCP port. ReadAheadBlocks => IntSet 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). ReadTableSpaceName => BoolWhen set to "true", this attribute supports tablespace replication. ReplacePathPrefix => BoolSet 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. RetryInterval => IntSpecifies the number of seconds that the system waits before resending a query. Example: "retryInterval=6;" SecretsManagerAccessRoleArn => StrThe 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". "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" and the "SecretsManagerAccessRoleArn" and "SecretsManagerSecretId" required to access it, see Using secrets to access AWS Database Migration Service resources (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide. SecretsManagerOracleAsmAccessRoleArn => StrRequired 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". 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 "AsmUserName", "AsmPassword", and "AsmServerName". You can't specify both. For more information on creating this "SecretsManagerOracleAsmSecret" and the "SecretsManagerOracleAsmAccessRoleArn" and "SecretsManagerOracleAsmSecretId" required to access it, see Using secrets to access AWS Database Migration Service resources (https://docs.aws.amazon.com/https:/docs.aws.amazon.com/dms/latest/userguide/CHAP_Security.html#security-iam-secretsmanager) in the AWS Database Migration Service User Guide. SecretsManagerOracleAsmSecretId => StrRequired only if your Oracle endpoint uses Advanced Storage Manager (ASM). The full ARN, partial ARN, or friendly name of the "SecretsManagerOracleAsmSecret" that contains the Oracle ASM connection details for the Oracle endpoint. SecretsManagerSecretId => StrThe full ARN, partial ARN, or friendly name of the "SecretsManagerSecret" that contains the Oracle endpoint connection details. SecurityDbEncryption => StrFor 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 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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the AWS Database Migration Service User Guide. SecurityDbEncryptionName => StrFor 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 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 (https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.Oracle.html#CHAP_Source.Oracle.Encryption) in the AWS Database Migration Service User Guide. ServerName => StrFully qualified domain name of the endpoint. SpatialDataOptionToGeoJsonFunctionName => StrUse this attribute to convert "SDO_GEOMETRY" to "GEOJSON" 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 of "SDOGEOJSON" and set "SpatialDataOptionToGeoJsonFunctionName" to call it instead. UseAlternateFolderForOnline => BoolSet 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 tells the DMS instance to use any specified prefix replacement to access all online redo logs. UsePathPrefix => StrSet 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. Username => StrEndpoint connection user name. SEE ALSOThis class forms part of Paws, describing an object used in Paws::DMS BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|