Package software.amazon.awscdk.services.dms

Interface CfnDataProvider.OracleSettingsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataProvider.OracleSettingsProperty.Jsii$Proxy

Enclosing class:

CfnDataProvider

@Stability(Stable)
public static interface CfnDataProvider.OracleSettingsProperty
extends software.amazon.jsii.JsiiSerializable

Provides information that defines an Oracle endpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 OracleSettingsProperty oracleSettingsProperty = OracleSettingsProperty.builder()
         .databaseName("databaseName")
         .port(123)
         .serverName("serverName")
         .sslMode("sslMode")
         // the properties below are optional
         .asmServer("asmServer")
         .certificateArn("certificateArn")
         .secretsManagerOracleAsmAccessRoleArn("secretsManagerOracleAsmAccessRoleArn")
         .secretsManagerOracleAsmSecretId("secretsManagerOracleAsmSecretId")
         .secretsManagerSecurityDbEncryptionAccessRoleArn("secretsManagerSecurityDbEncryptionAccessRoleArn")
         .secretsManagerSecurityDbEncryptionSecretId("secretsManagerSecurityDbEncryptionSecretId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataProvider.OracleSettingsProperty.Builder	A builder for CfnDataProvider.OracleSettingsProperty
static final class	CfnDataProvider.OracleSettingsProperty.Jsii$Proxy	An implementation for CfnDataProvider.OracleSettingsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataProvider.OracleSettingsProperty.Builder	builder()
default String	getAsmServer()	For an Oracle source endpoint, your ASM server address.
default String	getCertificateArn()
String	getDatabaseName()	Database name for the endpoint.
Number	getPort()	Endpoint TCP port.
default String	getSecretsManagerOracleAsmAccessRoleArn()	Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
default String	getSecretsManagerOracleAsmSecretId()	Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
default String	getSecretsManagerSecurityDbEncryptionAccessRoleArn()
default String	getSecretsManagerSecurityDbEncryptionSecretId()
String	getServerName()	Fully qualified domain name of the endpoint.
String	getSslMode()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDatabaseName

@Stability(Stable)
@NotNull
String getDatabaseName()

Database name for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-databasename

getPort

@Stability(Stable)
@NotNull
Number getPort()

Endpoint TCP port.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-port

getServerName

@Stability(Stable)
@NotNull
String getServerName()

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances , in the [Endpoint](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_Endpoint.html) .Address field.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-servername

getSslMode

@Stability(Stable)
@NotNull
String getSslMode()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-sslmode

getAsmServer

@Stability(Stable)
@Nullable
default String getAsmServer()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-asmserver

getCertificateArn

@Stability(Stable)
@Nullable
default String getCertificateArn()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-certificatearn

getSecretsManagerOracleAsmAccessRoleArn

@Stability(Stable)
@Nullable
default String getSecretsManagerOracleAsmAccessRoleArn()

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 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 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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmaccessrolearn

getSecretsManagerOracleAsmSecretId

@Stability(Stable)
@Nullable
default String getSecretsManagerOracleAsmSecretId()

Required only if your Oracle endpoint uses Automatic Storage Management (ASM).

The full ARN, partial ARN, or friendly name of the SecretsManagerOracleAsmSecret that contains the Oracle ASM connection details for the Oracle endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanageroracleasmsecretid

getSecretsManagerSecurityDbEncryptionAccessRoleArn

@Stability(Stable)
@Nullable
default String getSecretsManagerSecurityDbEncryptionAccessRoleArn()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionaccessrolearn

getSecretsManagerSecurityDbEncryptionSecretId

@Stability(Stable)
@Nullable
default String getSecretsManagerSecurityDbEncryptionSecretId()

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dms-dataprovider-oraclesettings.html#cfn-dms-dataprovider-oraclesettings-secretsmanagersecuritydbencryptionsecretid

builder

@Stability(Stable)
static CfnDataProvider.OracleSettingsProperty.Builder builder()

Returns:

a CfnDataProvider.OracleSettingsProperty.Builder of CfnDataProvider.OracleSettingsProperty