AWS DocumentDB
Learn the required and optional properties of creating a DocumentDB Connection, Credential, and Read Connector.
Prerequisites
- DocumentDB cluster
- Hostname of IP address
- Database name
Connection Properties
The following table describes the fields available when creating a new DocumentDB Connection. Create a connection using the information below and these step-by-step instructions.
Field | Required | Description |
---|---|---|
Access Type | Required | This connection type is Read-Only, Write-Only, or Read-Write. |
Connection Name | Required | Input your desired name. |
Host | Required | IP or the hostname of the DocumentDB. |
Port | Required | Host server port number. |
Database Name | Required | Name of the database. |
Connection String Parameter | Optional | Include additional properties you'd like to store within the Connection. |
Support a DNS-constructed Seed List | Optional | If selected, a DNS-constructed seed list is used. |
Connection is Through an SSH Proxy | Optional | Select if using an SSH tunnel to connect to DocumentDB. SSH tunnel must be configured within DocumentDB and Ascend. |
Requires Credentials | Optional | Check this box to create a new credential or select an existing credential. |
Credential Properties
The following table describes the fields available when creating a new DocumentDB credential.
Field | Required | Description |
---|---|---|
Credential Name | Required | The name to identify this credential with. This credential will be available as a selection for future use. |
Credential Type | Required | This field will automatically populate with DocumentDB . |
User | Required | DocumentDB data warehouse username to connect with. |
Password | Optional | DocumentDB data warehouse password to connect with. Not required if you are connecting to a public database. |
Read Connector Properties
The following table describes the fields available when creating a new DocumentDB Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.
Field | Required | Description |
---|---|---|
Name | Required | Provide a name for your connector. We recommend using lowercase with underscores in place of spaces. |
Description | Optional | Describes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons. |
Collection Name | Required | Name of the table being ingested. This can either be supplied manually or selected in Step 2 of Create a Read Connector. |
Replication Strategy | Optional | Full Resync, Full Resync in Parallel, Incremental Column, Table Snapshot, or Table Snapshot in Parallel. See Database Reading Strategies for more information. |
Updated 7 months ago