software.amazon.awssdk.services.databasemigration.model

Class OracleDataProviderSettings

java.lang.Object

software.amazon.awssdk.services.databasemigration.model.OracleDataProviderSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OracleDataProviderSettings.Builder,OracleDataProviderSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class OracleDataProviderSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OracleDataProviderSettings.Builder,OracleDataProviderSettings>

Provides information that defines an Oracle data provider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OracleDataProviderSettings.Builder

Method Summary

Modifier and Type	Method and Description
String	asmServer() The address of your Oracle Automatic Storage Management (ASM) server.
static OracleDataProviderSettings.Builder	builder()
String	certificateArn() The Amazon Resource Name (ARN) of the certificate used for SSL connection.
String	databaseName() The database name on the Oracle data provider.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	port() The port value for the Oracle data provider.
List<SdkField<?>>	sdkFields()
String	secretsManagerOracleAsmAccessRoleArn() The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.
String	secretsManagerOracleAsmSecretId() The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.
String	secretsManagerSecurityDbEncryptionAccessRoleArn() The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.
String	secretsManagerSecurityDbEncryptionSecretId() The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password.
static Class<? extends OracleDataProviderSettings.Builder>	serializableBuilderClass()
String	serverName() The name of the Oracle server.
DmsSslModeValue	sslMode() The SSL mode used to connect to the Oracle data provider.
String	sslModeAsString() The SSL mode used to connect to the Oracle data provider.
OracleDataProviderSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

serverName

public final String serverName()

The name of the Oracle server.

Returns:

The name of the Oracle server.

port

public final Integer port()

The port value for the Oracle data provider.

Returns:

The port value for the Oracle data provider.

databaseName

public final String databaseName()

The database name on the Oracle data provider.

Returns:

The database name on the Oracle data provider.

sslMode

public final DmsSslModeValue sslMode()

The SSL mode used to connect to the Oracle data provider. The default value is none.

If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

Returns:

The SSL mode used to connect to the Oracle data provider. The default value is none.

See Also:

DmsSslModeValue

sslModeAsString

public final String sslModeAsString()

The SSL mode used to connect to the Oracle data provider. The default value is none.

If the service returns an enum value that is not available in the current SDK version, sslMode will return DmsSslModeValue.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sslModeAsString().

Returns:

The SSL mode used to connect to the Oracle data provider. The default value is none.

See Also:

DmsSslModeValue

certificateArn

public final String certificateArn()

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

Returns:

The Amazon Resource Name (ARN) of the certificate used for SSL connection.

asmServer

public final String asmServer()

The address of your Oracle Automatic Storage Management (ASM) server. 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.

Returns:

The address of your Oracle Automatic Storage Management (ASM) server. 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.

secretsManagerOracleAsmSecretId

public final String secretsManagerOracleAsmSecretId()

The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.

Required only if your data provider uses the Oracle ASM server.

Returns:

The identifier of the secret in Secrets Manager that contains the Oracle ASM connection details.

Required only if your data provider uses the Oracle ASM server.

secretsManagerOracleAsmAccessRoleArn

public final String secretsManagerOracleAsmAccessRoleArn()

The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.

Returns:

The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the Oracle ASM connection details.

secretsManagerSecurityDbEncryptionSecretId

public final String secretsManagerSecurityDbEncryptionSecretId()

The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.

Returns:

The identifier of the secret in Secrets Manager that contains the transparent data encryption (TDE) password. DMS requires this password to access Oracle redo logs encrypted by TDE using Binary Reader.

secretsManagerSecurityDbEncryptionAccessRoleArn

public final String secretsManagerSecurityDbEncryptionAccessRoleArn()

The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.

Returns:

The ARN of the IAM role that provides access to the secret in Secrets Manager that contains the TDE password.

toBuilder

public OracleDataProviderSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OracleDataProviderSettings.Builder,OracleDataProviderSettings>

builder

public static OracleDataProviderSettings.Builder builder()

serializableBuilderClass

public static Class<? extends OracleDataProviderSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo