Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateOracleConnectionDetails

The information to update an Oracle Database Connection.

Properties

Optional connectionString

connectionString: undefined | string

Connect descriptor or Easy Connect Naming method used to connect to a database.

Const connectionType

connectionType: string = "ORACLE"

Optional databaseId

databaseId: undefined | string

The OCID of the database being referenced.

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional description

description: undefined | string

Metadata about this specific object.

Optional displayName

displayName: undefined | string

An object's Display Name.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

Optional keyId

keyId: undefined | string

Refers to the customer's master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Optional nsgIds

nsgIds: Array<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Optional password

password: undefined | string

The password Oracle GoldenGate uses to connect the associated system of the given technology. It must conform to the specific security requirements including length, case sensitivity, and so on.

Optional privateIp

privateIp: undefined | string

Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection's endpoint in the customer's VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Optional routingMethod

routingMethod: model.RoutingMethod

Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service's network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment's private endpoint through the deployment's subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

Optional sessionMode

sessionMode: undefined | string

The mode of the database connection session to be established by the data client. 'REDIRECT' - for a RAC database, 'DIRECT' - for a non-RAC database. Connection to a RAC database involves a redirection received from the SCAN listeners to the database node to connect to. By default the mode would be DIRECT.

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

Optional username

username: undefined | string

The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Optional vaultId

vaultId: undefined | string

Refers to the customer's vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Optional wallet

wallet: undefined | string

The wallet contents Oracle GoldenGate uses to make connections to a database. This attribute is expected to be base64 encoded.

Methods

getDeserializedJsonObj

getJsonObj