Package com.pulumi.aws.dms.outputs
Class EndpointOracleSettings
- java.lang.Object
-
- com.pulumi.aws.dms.outputs.EndpointOracleSettings
-
public final class EndpointOracleSettings extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classEndpointOracleSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Optional<java.lang.Boolean>accessAlternateDirectly()java.util.Optional<java.lang.Integer>additionalArchivedLogDestId()java.util.Optional<java.lang.Boolean>addSupplementalLogging()java.util.Optional<java.lang.Boolean>allowSelectedNestedTables()java.util.Optional<java.lang.Integer>archivedLogDestId()java.util.Optional<java.lang.Boolean>archivedLogsOnly()java.util.Optional<java.lang.String>asmPassword()java.util.Optional<java.lang.String>asmServer()java.util.Optional<java.lang.String>asmUser()java.util.Optional<java.lang.String>authenticationMethod()static EndpointOracleSettings.Builderbuilder()static EndpointOracleSettings.Builderbuilder(EndpointOracleSettings defaults)java.util.Optional<java.lang.String>charLengthSemantics()java.util.Optional<java.lang.Boolean>convertTimestampWithZoneToUtc()java.util.Optional<java.lang.Boolean>directPathNoLog()java.util.Optional<java.lang.Boolean>directPathParallelLoad()java.util.Optional<java.lang.Boolean>enableHomogenousTablespace()java.util.List<java.lang.Integer>extraArchivedLogDestIds()java.util.Optional<java.lang.Boolean>failTaskOnLobTruncation()java.util.Optional<java.lang.Integer>numberDatatypeScale()java.util.Optional<java.lang.Integer>openTransactionWindow()java.util.Optional<java.lang.String>oraclePathPrefix()java.util.Optional<java.lang.Integer>parallelAsmReadThreads()java.util.Optional<java.lang.Integer>readAheadBlocks()java.util.Optional<java.lang.Boolean>readTableSpaceName()java.util.Optional<java.lang.Boolean>replacePathPrefix()java.util.Optional<java.lang.Integer>retryInterval()java.util.Optional<java.lang.String>secretsManagerOracleAsmAccessRoleArn()java.util.Optional<java.lang.String>secretsManagerOracleAsmSecretId()java.util.Optional<java.lang.String>securityDbEncryption()java.util.Optional<java.lang.String>securityDbEncryptionName()java.util.Optional<java.lang.String>spatialDataOptionToGeoJsonFunctionName()java.util.Optional<java.lang.Integer>standbyDelayTime()java.util.Optional<java.lang.Boolean>trimSpaceInChar()java.util.Optional<java.lang.Boolean>useAlternateFolderForOnline()java.util.Optional<java.lang.Boolean>useBfile()java.util.Optional<java.lang.Boolean>useDirectPathFullLoad()java.util.Optional<java.lang.Boolean>useLogminerReader()java.util.Optional<java.lang.String>usePathPrefix()
-
-
-
Method Detail
-
accessAlternateDirectly
public java.util.Optional<java.lang.Boolean> accessAlternateDirectly()
- Returns:
- 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.
-
addSupplementalLogging
public java.util.Optional<java.lang.Boolean> addSupplementalLogging()
- Returns:
- 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.
-
additionalArchivedLogDestId
public java.util.Optional<java.lang.Integer> additionalArchivedLogDestId()
- Returns:
- Set this attribute with `archivedLogDestId` in a primary/standby setup. This attribute is useful in the case of a switchover.
-
allowSelectedNestedTables
public java.util.Optional<java.lang.Boolean> allowSelectedNestedTables()
- Returns:
- Set this attribute to `true` to enable replication of Oracle tables containing columns that are nested tables or defined types.
-
archivedLogDestId
public java.util.Optional<java.lang.Integer> archivedLogDestId()
- Returns:
- Specifies the ID of the destination for the archived redo logs. This value should be the same as a number in the destId column of the v$archived_log view.
-
archivedLogsOnly
public java.util.Optional<java.lang.Boolean> archivedLogsOnly()
- Returns:
- When this field is set to `true`, AWS DMS only accesses the archived redo logs.
-
asmPassword
public java.util.Optional<java.lang.String> asmPassword()
- Returns:
- For an Oracle source endpoint, your Oracle Automatic Storage Management (ASM) password.
-
asmServer
public java.util.Optional<java.lang.String> asmServer()
- Returns:
- For an Oracle source endpoint, your ASM server address.
-
asmUser
public java.util.Optional<java.lang.String> asmUser()
- Returns:
- For an Oracle source endpoint, your ASM user name.
-
authenticationMethod
public java.util.Optional<java.lang.String> authenticationMethod()
- Returns:
- Authentication mechanism to access the Oracle source endpoint. Default is `password`. Valid values are `password` and `kerberos`.
-
charLengthSemantics
public java.util.Optional<java.lang.String> charLengthSemantics()
- Returns:
- Specifies whether the length of a character column is in bytes or in characters. Valid values are `default`, `char`, and `byte`.
-
convertTimestampWithZoneToUtc
public java.util.Optional<java.lang.Boolean> convertTimestampWithZoneToUtc()
- Returns:
- When `true`, converts timestamps with the timezone datatype to their UTC value.
-
directPathNoLog
public java.util.Optional<java.lang.Boolean> directPathNoLog()
- Returns:
- 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.
-
directPathParallelLoad
public java.util.Optional<java.lang.Boolean> directPathParallelLoad()
- Returns:
- When set to `true`, this attribute specifies a parallel load when useDirectPathFullLoad is set to true.
-
enableHomogenousTablespace
public java.util.Optional<java.lang.Boolean> enableHomogenousTablespace()
- Returns:
- Set this attribute to enable homogenous tablespace replication and create existing tables or indexes under the same tablespace on the target.
-
extraArchivedLogDestIds
public java.util.List<java.lang.Integer> extraArchivedLogDestIds()
- Returns:
- Specifies the IDs of one more destinations for one or more archived redo logs. These IDs are the values of the destId column in the v$archived_log view.
-
failTaskOnLobTruncation
public java.util.Optional<java.lang.Boolean> failTaskOnLobTruncation()
- Returns:
- When set to `true`, this attribute causes a task to fail if the actual size of an LOB column is greater than the specified lob_max_size.
-
numberDatatypeScale
public java.util.Optional<java.lang.Integer> numberDatatypeScale()
- Returns:
- Specifies the number scale.
-
openTransactionWindow
public java.util.Optional<java.lang.Integer> openTransactionWindow()
- Returns:
- The timeframe in minutes to check for open transactions for a CDC-only task. You can specify an integer value between 0 (the default) and 240 (the maximum).
-
oraclePathPrefix
public java.util.Optional<java.lang.String> oraclePathPrefix()
- Returns:
- 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.
-
parallelAsmReadThreads
public java.util.Optional<java.lang.Integer> parallelAsmReadThreads()
- Returns:
- 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).
-
readAheadBlocks
public java.util.Optional<java.lang.Integer> readAheadBlocks()
- Returns:
- 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).
-
readTableSpaceName
public java.util.Optional<java.lang.Boolean> readTableSpaceName()
- Returns:
- When set to `true`, this attribute supports tablespace replication.
-
replacePathPrefix
public java.util.Optional<java.lang.Boolean> replacePathPrefix()
- Returns:
- 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.
-
retryInterval
public java.util.Optional<java.lang.Integer> retryInterval()
- Returns:
- Specifies the number of seconds that the system waits before resending a query.
-
secretsManagerOracleAsmAccessRoleArn
public java.util.Optional<java.lang.String> secretsManagerOracleAsmAccessRoleArn()
- Returns:
- Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN of the IAM role that specifies AWS DMS as the trusted entity and grants the required permissions to access the `secretsManagerOracleAsmSecretId`.
-
secretsManagerOracleAsmSecretId
public java.util.Optional<java.lang.String> secretsManagerOracleAsmSecretId()
- Returns:
- Required only if your Oracle endpoint uses Automatic Storage Management (ASM). The full ARN, partial ARN, or friendly name of the secret that contains the Oracle ASM connection details for the Oracle endpoint.
-
securityDbEncryption
public java.util.Optional<java.lang.String> securityDbEncryption()
- Returns:
- 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
public java.util.Optional<java.lang.String> securityDbEncryptionName()
- Returns:
- 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
public java.util.Optional<java.lang.String> spatialDataOptionToGeoJsonFunctionName()
- Returns:
- Use this attribute to convert SDO_GEOMETRY to GEOJSON format. By default, DMS calls the SDO2GEOJSON custom function if present and accessible.
-
standbyDelayTime
public java.util.Optional<java.lang.Integer> standbyDelayTime()
- Returns:
- 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.
-
trimSpaceInChar
public java.util.Optional<java.lang.Boolean> trimSpaceInChar()
- Returns:
- Use this attribute to trim data on CHAR and NCHAR data types during migration. The default value is `true`.
-
useAlternateFolderForOnline
public java.util.Optional<java.lang.Boolean> useAlternateFolderForOnline()
- Returns:
- 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.
-
useBfile
public java.util.Optional<java.lang.Boolean> useBfile()
- Returns:
- Set this attribute to `true` to capture change data using the Binary Reader utility. Set `useLogminerReader` to `false` to set this attribute to `true`.
-
useDirectPathFullLoad
public java.util.Optional<java.lang.Boolean> useDirectPathFullLoad()
- Returns:
- 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).
-
useLogminerReader
public java.util.Optional<java.lang.Boolean> useLogminerReader()
- Returns:
- 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.
-
usePathPrefix
public java.util.Optional<java.lang.String> usePathPrefix()
- Returns:
- 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.
-
builder
public static EndpointOracleSettings.Builder builder()
-
builder
public static EndpointOracleSettings.Builder builder(EndpointOracleSettings defaults)
-
-