Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateMongoDbConnectionDetails

The information about a new MongoDB Connection.

Properties

compartmentId

compartmentId: string

The OCID of the compartment being referenced.

Optional connectionString

connectionString: undefined | string

MongoDB connection string. e.g.: 'mongodb://mongodb0.example.com:27017/recordsrecords'

Const connectionType

connectionType: string = "MONGODB"

Optional databaseId

databaseId: undefined | string

The OCID of the Oracle Autonomous Json Database.

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.

displayName

displayName: 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 locks

Locks associated with this resource.

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 database. Deprecated: This field is deprecated and replaced by "passwordSecretId". This field will be removed after February 15 2026.

Optional passwordSecretId

passwordSecretId: undefined | string

The OCID of the Secret that stores the password Oracle GoldenGate uses to connect the associated database. Note: When provided, 'password' field must not be provided.

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 securityProtocol

securityProtocol: undefined | string

Security Type for MongoDB.

Optional subnetId

subnetId: undefined | string

The OCID of the target subnet of the dedicated connection.

technologyType

technologyType: string

The MongoDB technology type.

Optional tlsCaFile

tlsCaFile: undefined | string

Database Certificate - The base64 encoded content of a .pem file, containing the server public key (for 1 and 2-way SSL). It is not included in GET responses if the {@code view=COMPACT} query parameter is specified.

Optional tlsCertificateKeyFile

tlsCertificateKeyFile: undefined | string

Client Certificate - The base64 encoded content of a .pem file, containing the client public key (for 2-way SSL). Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFileSecretId". This field will be removed after February 15 2026.

Optional tlsCertificateKeyFilePassword

tlsCertificateKeyFilePassword: undefined | string

Client Certificate key file password. Deprecated: This field is deprecated and replaced by "tlsCertificateKeyFilePasswordSecretId". This field will be removed after February 15 2026.

Optional tlsCertificateKeyFilePasswordSecretId

tlsCertificateKeyFilePasswordSecretId: undefined | string

The OCID of the Secret that stores the password of the tls certificate key file. Note: When provided, 'tlsCertificateKeyFilePassword' field must not be provided.

Optional tlsCertificateKeyFileSecretId

tlsCertificateKeyFileSecretId: undefined | string

The OCID of the Secret that stores the certificate key file of the mtls connection.

  • The content of a .pem file containing the client private key (for 2-way SSL). Note: When provided, 'tlsCertificateKeyFile' field must not be provided.

Optional username

username: undefined | string

The username Oracle GoldenGate uses to connect to the database. This username must already exist and be available by the database to be connected to.

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