Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdateOracleNosqlConnectionDetails

The information to update a Oracle NoSQL Connection.

Properties

Const connectionType

connectionType: string = "ORACLE_NOSQL"

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 doesUseSecretIds

doesUseSecretIds: undefined | false | true

Indicates that sensitive attributes are provided via Secrets.

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 privateKeyFile

privateKeyFile: undefined | string

The base64 encoded content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Deprecated: This field is deprecated and replaced by "privateKeyFileSecretId". This field will be removed after February 15 2026.

Optional privateKeyFileSecretId

privateKeyFileSecretId: undefined | string

The OCID of the Secret that stores the content of the private key file (PEM file) corresponding to the API key of the fingerprint. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm Note: When provided, 'privateKeyFile' field must not be provided.

Optional privateKeyPassphrase

privateKeyPassphrase: undefined | string

The passphrase of the private key. Deprecated: This field is deprecated and replaced by "privateKeyPassphraseSecretId". This field will be removed after February 15 2026.

Optional privateKeyPassphraseSecretId

privateKeyPassphraseSecretId: undefined | string

The OCID of the Secret that stores the passphrase of the private key. Note: When provided, 'privateKeyPassphrase' field must not be provided.

Optional publicKeyFingerprint

publicKeyFingerprint: undefined | string

The fingerprint of the API Key of the user specified by the userId. See documentation: https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcredentials.htm

Optional region

region: undefined | string

The name of the region. e.g.: us-ashburn-1 If the region is not provided, backend will default to the default region.

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 securityAttributes

securityAttributes: undefined | object

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}}

Optional shouldUseResourcePrincipal

shouldUseResourcePrincipal: undefined | false | true

Specifies that the user intends to authenticate to the instance using a resource principal. Default: false

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

Optional tenancyId

tenancyId: undefined | string

The OCID of the related OCI tenancy.

Optional userId

userId: undefined | string

The OCID of the OCI user who will access the Oracle NoSQL database. The user must have write access to the table they want to connect to. If the user is not provided, backend will default to the user who is calling the API endpoint.

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.

Methods

getDeserializedJsonObj

getJsonObj