AWS::DMS::DataProvider OracleSettings

Provides information that defines an Oracle endpoint.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "AsmServer" : String,
  "CertificateArn" : String,
  "DatabaseName" : String,
  "Port" : Integer,
  "SecretsManagerOracleAsmAccessRoleArn" : String,
  "SecretsManagerOracleAsmSecretId" : String,
  "SecretsManagerSecurityDbEncryptionAccessRoleArn" : String,
  "SecretsManagerSecurityDbEncryptionSecretId" : String,
  "ServerName" : String,
  "SslMode" : String
}

YAML

  AsmServer: String
  CertificateArn: String
  DatabaseName: String
  Port: Integer
  SecretsManagerOracleAsmAccessRoleArn: String
  SecretsManagerOracleAsmSecretId: String
  SecretsManagerSecurityDbEncryptionAccessRoleArn: String
  SecretsManagerSecurityDbEncryptionSecretId: String
  ServerName: String
  SslMode: String

Properties

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.

Required: No

Type: String

Update requires: No interruption

CertificateArn

Property description not available.

Required: No

Type: String

Update requires: No interruption

DatabaseName

Database name for the endpoint.

Required: Yes

Type: String

Update requires: No interruption

Port

Endpoint TCP port.

Required: Yes

Type: Integer

Update requires: No interruption

SecretsManagerOracleAsmAccessRoleArn

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.

Note

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.

Required: No

Type: String

Update requires: No interruption

SecretsManagerOracleAsmSecretId

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.

Required: No

Type: String

Update requires: No interruption

SecretsManagerSecurityDbEncryptionAccessRoleArn

Property description not available.

Required: No

Type: String

Update requires: No interruption

SecretsManagerSecurityDbEncryptionSecretId

Property description not available.

Required: No

Type: String

Update requires: No interruption

ServerName

Fully qualified domain name of the endpoint.

For an Amazon RDS Oracle instance, this is the output of DescribeDBInstances, in the Endpoint.Address field.

Required: Yes

Type: String

Update requires: No interruption

SslMode

Property description not available.

Required: Yes

Type: String

Allowed values: none | require | verify-ca | verify-full

Update requires: No interruption