@Generated(value="software.amazon.awssdk:codegen") public final class OracleSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OracleSettings.Builder,OracleSettings>
Provides information that defines an Oracle endpoint.
| Modifier and Type | Class and Description |
|---|---|
static interface |
OracleSettings.Builder |
| Modifier and Type | Method and Description |
|---|---|
Boolean |
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. |
Integer |
additionalArchivedLogDestId()
Set this attribute with
archivedLogDestId in a primary/ standby setup. |
Boolean |
addSupplementalLogging()
Set this attribute to set up table-level supplemental logging for the Oracle database.
|
Boolean |
allowSelectNestedTables()
Set this attribute to
true to enable replication of Oracle tables containing columns that are nested
tables or defined types. |
Integer |
archivedLogDestId()
Specifies the destination of the archived redo logs.
|
Boolean |
archivedLogsOnly()
When this field is set to
Y, AWS DMS only accesses the archived redo logs. |
String |
asmPassword()
For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
|
String |
asmServer()
For an Oracle source endpoint, your ASM server address.
|
String |
asmUser()
For an Oracle source endpoint, your ASM user name.
|
static OracleSettings.Builder |
builder() |
CharLengthSemantics |
charLengthSemantics()
Specifies whether the length of a character column is in bytes or in characters.
|
String |
charLengthSemanticsAsString()
Specifies whether the length of a character column is in bytes or in characters.
|
String |
databaseName()
Database name for the endpoint.
|
Boolean |
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. |
Boolean |
directPathParallelLoad()
When set to
true, this attribute specifies a parallel load when useDirectPathFullLoad
is set to Y. |
Boolean |
enableHomogenousTablespace()
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the
same tablespace on the target.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Boolean |
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. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
numberDatatypeScale()
Specifies the number scale.
|
String |
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.
|
Integer |
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).
|
String |
password()
Endpoint connection password.
|
Integer |
port()
Endpoint TCP port.
|
Integer |
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).
|
Boolean |
readTableSpaceName()
When set to
true, this attribute supports tablespace replication. |
Boolean |
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.
|
Integer |
retryInterval()
Specifies the number of seconds that the system waits before resending a query.
|
List<SdkField<?>> |
sdkFields() |
String |
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. |
String |
secretsManagerOracleAsmAccessRoleArn()
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
|
String |
secretsManagerOracleAsmSecretId()
Required only if your Oracle endpoint uses Advanced Storage Manager (ASM).
|
String |
secretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the
SecretsManagerSecret that contains the Oracle
endpoint connection details. |
String |
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.
|
String |
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.
|
static Class<? extends OracleSettings.Builder> |
serializableBuilderClass() |
String |
serverName()
Fully qualified domain name of the endpoint.
|
String |
spatialDataOptionToGeoJsonFunctionName()
Use this attribute to convert
SDO_GEOMETRY to GEOJSON format. |
OracleSettings.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
Boolean |
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. |
String |
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.
|
String |
username()
Endpoint connection user name.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Boolean addSupplementalLogging()
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.
If you use this option, you still need to enable database-level supplemental logging.
public final Integer archivedLogDestId()
Specifies 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.
public final Integer additionalArchivedLogDestId()
Set 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.
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.public final Boolean allowSelectNestedTables()
Set this attribute to true to enable replication of Oracle tables containing columns that are nested
tables or defined types.
true to enable replication of Oracle tables containing columns that
are nested tables or defined types.public final Integer 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). You can specify an integer value between 2 (the default)
and 8 (the maximum). Use this attribute together with the readAheadBlocks attribute.
readAheadBlocks
attribute.public final Integer 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). You can specify an integer value between 1000 (the default) and 200,000 (the maximum).
public final Boolean 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. This tells the DMS instance to not access redo logs through any specified path
prefix replacement using direct file access.
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.public final Boolean 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. This tells the DMS instance to use any specified prefix replacement to access all
online redo logs.
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.public final String 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. This value specifies the default Oracle root used to access the redo logs.
public final String 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. This value specifies the path prefix used to replace the default Oracle root to access the redo logs.
public final Boolean 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. This setting tells DMS instance to replace the default Oracle root with the specified
usePathPrefix setting to access the redo logs.
usePathPrefix setting to access the redo logs.public final Boolean enableHomogenousTablespace()
Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
public final Boolean 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.
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 final Boolean archivedLogsOnly()
When 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.
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.public final String asmPassword()
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 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.
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.public final String asmServer()
For 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.
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.public final String asmUser()
For 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.
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.public final CharLengthSemantics charLengthSemantics()
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;
If the service returns an enum value that is not available in the current SDK version,
charLengthSemantics will return CharLengthSemantics.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from charLengthSemanticsAsString().
CHAR. Otherwise, the
character column length is in bytes.
Example: charLengthSemantics=CHAR;
CharLengthSemanticspublic final String charLengthSemanticsAsString()
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;
If the service returns an enum value that is not available in the current SDK version,
charLengthSemantics will return CharLengthSemantics.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from charLengthSemanticsAsString().
CHAR. Otherwise, the
character column length is in bytes.
Example: charLengthSemantics=CHAR;
CharLengthSemanticspublic final String databaseName()
Database name for the endpoint.
public final Boolean directPathParallelLoad()
When 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.
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.public final Boolean 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.
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.
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.
public final Integer numberDatatypeScale()
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
Example: numberDataTypeScale=12
public final String password()
Endpoint connection password.
public final Integer port()
Endpoint TCP port.
public final Boolean readTableSpaceName()
When set to true, this attribute supports tablespace replication.
true, this attribute supports tablespace replication.public final Integer retryInterval()
Specifies the number of seconds that the system waits before resending a query.
Example: retryInterval=6;
Example: retryInterval=6;
public final String 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. 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.
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.public final String 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. 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.
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.public final String serverName()
Fully qualified domain name of the endpoint.
public final String spatialDataOptionToGeoJsonFunctionName()
Use 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.
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.public final String username()
Endpoint connection user name.
public final String 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. 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 in the AWS Database Migration Service
User Guide.
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 in the AWS Database Migration
Service User Guide.
public final String secretsManagerSecretId()
The full ARN, partial ARN, or friendly name of the SecretsManagerSecret that contains the Oracle
endpoint connection details.
SecretsManagerSecret that contains the
Oracle endpoint connection details.public final String secretsManagerOracleAsmAccessRoleArn()
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. 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 in the AWS Database Migration Service
User Guide.
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 in the AWS Database Migration
Service User Guide.
public final String secretsManagerOracleAsmSecretId()
Required 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.
SecretsManagerOracleAsmSecret that contains the Oracle ASM connection
details for the Oracle endpoint.public OracleSettings.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<OracleSettings.Builder,OracleSettings>public static OracleSettings.Builder builder()
public static Class<? extends OracleSettings.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2021. All rights reserved.