10.6.5 Amazon DocumentDB
- About Amazon DocumentDB Connections
- Before You Begin
- Create and Validate an Amazon DocumentDB Connection
- Use an Amazon DocumentDB Connection in Replicat
Parent topic: NoSQL and Document Stores
10.6.5.1 About Amazon DocumentDB Connections
An Amazon DocumentDB connection stores the information that Oracle GoldenGate for Distributed Applications and Analytics uses to connect to an Amazon DocumentDB deployment.
You can use the connection with Extract to capture transactional changes from Amazon DocumentDB as a source and with Replicat to deliver transactional changes to Amazon DocumentDB as a target. After you create and validate the connection, you can reuse it across multiple Oracle GoldenGate for Distributed Applications and Analytics processes.
The connection stores the connection string, authentication settings, security configuration, and optional runtime settings independently of the process configuration.
Parent topic: Amazon DocumentDB
10.6.5.2 Before You Begin
Before creating an Amazon DocumentDB connection, ensure that you have the following:
- An Oracle GoldenGate for Distributed Applications and Analytics deployment.
- Network connectivity between the Oracle GoldenGate for Distributed Applications and Analytics deployment and the Amazon DocumentDB cluster.
- A valid connection string for the Amazon DocumentDB deployment.
- Authentication credentials or security artifacts required for the selected security protocol.
- The required client libraries. Download the supported client libraries by using the Dependency Downloader for MongoDB.
- Common runtime settings, such as the runtime classpath, configured to reference the downloaded client libraries.
- Proxy information if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses Amazon DocumentDB through an HTTP proxy.
Parent topic: Amazon DocumentDB
10.6.5.3 Create and Validate an Amazon DocumentDB Connection
Use the Add Connection page to create an Amazon DocumentDB connection.
Procedure
- In the navigation menu, select DB Connections.
- Click Add Connection.
- In Connection Alias, enter a unique name for the connection.
- From Technology Type, select Amazon DocumentDB.
- In the Technology Settings section, provide the Amazon DocumentDB connection
information.
Configure the following technology settings:
Connection String – Specifies the connection string used to connect to the Amazon DocumentDB deployment. This field is required.
- Configure the Security Settings section.
Configure the following security settings.
PLAIN AuthenticationConfigure the following settings when Security Protocol is PLAIN:
- Username – Specifies the user name used to connect to the Amazon DocumentDB deployment.
- Password – Specifies the password associated with the user name. This field is treated as sensitive information.
TLS SettingsNote:
The Password property is deprecated and will be replaced by passwordSecretId. This property will be removed after February 15, 2026.Configure the following settings when Security Protocol is TLS:
- Username – Specifies the user name used to connect to the Amazon DocumentDB deployment.
- Password – Specifies the password associated with the user name.
- TLS CA Certificate – Upload the Base64-encoded CA certificate used to validate the Amazon DocumentDB server certificate.
Configure the following settings when Security Protocol is MTLS:
- Username – Specifies the user name used to connect to the Amazon DocumentDB deployment.
- Password – Specifies the password associated with the user name.
- TLS CA Certificate – Upload the Base64-encoded CA certificate used to validate the Amazon DocumentDB server certificate.
- Client Certificate and Private Key – Upload the client certificate and private key used for mutual TLS authentication.
- Client Key Password – Specifies the password protecting the client private key, when applicable.
Configure the following settings when Security Protocol is X509:
- TLS CA Certificate – Upload the Base64-encoded CA certificate used to validate the Amazon DocumentDB server certificate.
- Client Certificate and Private Key – Upload the client certificate and private key used for X.509 authentication.
- Client Key Password – Specifies the password protecting the client private key, when applicable.
Note:
The client certificate and private key must not be encrypted. - Configure Common Settings, if additional runtime configuration is required.
Configure the following common settings:
Classpath – Specifies the runtime classpath used to load the required client libraries. You can use Dependency Downloader to download client libraries
Note:
- Download the supported client libraries by using the Dependency Downloader for MongoDB.
- Configure the runtime classpath to reference the downloaded client libraries before starting the Extract or Replicat process.
- (Optional) Configure Proxy Settings if the Oracle GoldenGate for Distributed
Applications and Analytics deployment accesses Amazon DocumentDB through an HTTP
proxy. Proxy Settings
Configure the following proxy settings:
- Proxy URL – Specifies the URL or host name of the proxy server used to access Amazon DocumentDB.
- Proxy Port – Specifies the port number of the proxy server.
- Proxy Username – Specifies the user name for proxy authentication, if required.
- Proxy Password – Specifies the password for proxy authentication. This field is treated as sensitive information.
- Truststore – Specifies the Java truststore file that contains the certificate authority (CA) certificates used to validate the proxy server certificate, when required.
- Truststore Password – Specifies the password associated with the truststore.
- Keystore – Specifies the Java keystore file containing the client certificate and private key used for client authentication, when required.
- Keystore Password – Specifies the password associated with the keystore.
- SSL Key Password – Specifies the password protecting the private key stored in the keystore when it differs from the keystore password.
.Note:
Configure the proxy and SSL settings only if the Oracle GoldenGate for Distributed Applications and Analytics deployment accesses Amazon DocumentDB through a proxy that requires authentication or TLS. If the deployment has direct network connectivity to Amazon DocumentDB, leave the Proxy Settings blank - Click Submit.
- On the DB Connections page, click DBLOGIN to validate the connection.
Note:
A successful DBLOGIN validates only the saved connection information. It does not validate the Extract or Replicat configuration. After successful validation, the connection is available for selection during Extract or Replicat creation.
Parent topic: Amazon DocumentDB
10.6.5.4 Use an Amazon DocumentDB Connection in Replicat
- Create or edit an Extract.
- Select Amazon DocumentDB as the source technology.
- Select the validated Amazon DocumentDB connection.
- Complete the remaining Extract configuration.
- Create and start the Extract.
Use the Connection with Replicat
- Create or edit a Replicat.
- Select Amazon DocumentDB as the target technology.
- Select the validated Amazon DocumentDB connection.
- Complete the remaining Replicat configuration.
- Create and start the Replicat.
Related Topics
Parent topic: Amazon DocumentDB