interface OracleSettingsProperty

Language	Type name
.NET	Amazon.CDK.AWS.DMS.CfnDataProvider.OracleSettingsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsdms#CfnDataProvider_OracleSettingsProperty
Java	software.amazon.awscdk.services.dms.CfnDataProvider.OracleSettingsProperty
Python	aws_cdk.aws_dms.CfnDataProvider.OracleSettingsProperty
TypeScript	aws-cdk-lib » aws_dms » CfnDataProvider » OracleSettingsProperty

Provides information that defines an Oracle endpoint.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_dms as dms } from 'aws-cdk-lib';
const oracleSettingsProperty: dms.CfnDataProvider.OracleSettingsProperty = {
  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',
};

Properties

Name	Type	Description
databaseName	string	Database name for the endpoint.
port	number	Endpoint TCP port.
serverName	string	Fully qualified domain name of the endpoint.
sslMode	string
asmServer?	string	For an Oracle source endpoint, your ASM server address.
certificateArn?	string
secretsManagerOracleAsmAccessRoleArn?	string	Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
secretsManagerOracleAsmSecretId?	string	Required only if your Oracle endpoint uses Automatic Storage Management (ASM).
secretsManagerSecurityDbEncryptionAccessRoleArn?	string
secretsManagerSecurityDbEncryptionSecretId?	string

---

databaseName

Type: string

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

---

port

Type: number

Endpoint TCP port.

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

---

serverName

Type: string

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

---

sslMode

Type: string

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

---

asmServer?

Type: string (optional)

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

---

certificateArn?

Type: string (optional)

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

---

secretsManagerOracleAsmAccessRoleArn?

Type: string (optional)

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

---

secretsManagerOracleAsmSecretId?

Type: string (optional)

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

---

secretsManagerSecurityDbEncryptionAccessRoleArn?

Type: string (optional)

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

---

secretsManagerSecurityDbEncryptionSecretId?

Type: string (optional)

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