AWS DocumentDB

Learn the required and optional properties of creating a DocumentDB Connection, Credential, and Read Connector.

name of connection

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.

FieldRequiredDescription
Access TypeRequiredThis connection type is Read-Only, Write-Only, or Read-Write.
Connection NameRequiredInput your desired name.
HostRequiredIP or the hostname of the DocumentDB.
PortRequiredHost server port number.
Database NameRequiredName of the database.
Connection String ParameterOptionalInclude additional properties you'd like to store within the Connection.
Support a DNS-constructed Seed ListOptionalIf selected, a DNS-constructed seed list is used.
Connection is Through an SSH ProxyOptionalSelect if using an SSH tunnel to connect to DocumentDB. SSH tunnel must be configured within DocumentDB and Ascend.
Requires CredentialsOptionalCheck 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.

FieldRequiredDescription
Credential NameRequiredThe name to identify this credential with. This credential will be available as a selection for future use.
Credential TypeRequiredThis field will automatically populate with DocumentDB.
UserRequiredDocumentDB data warehouse username to connect with.
PasswordOptionalDocumentDB 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.

FieldRequiredDescription
NameRequiredProvide a name for your connector. We recommend using lowercase with underscores in place of spaces.
DescriptionOptionalDescribes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons.
Collection NameRequiredName of the table being ingested. This can either be supplied manually or selected in Step 2 of Create a Read Connector.
Replication StrategyOptionalFull Resync, Full Resync in Parallel, Incremental Column, Table Snapshot, or Table Snapshot in Parallel. See Database Reading Strategies for more information.