Amazon DocumentDB API Configuration

Request

POST https://api.fivetran.com/v1/connections

{
  "group_id": "group_id",
  "service": "documentdb",
  "trust_certificates": true,
  "trust_fingerprints": true,
  "run_setup_tests": true,
  "paused": false,
  "pause_after_trial": false,
  "sync_frequency": 1440,
  "data_delay_sensitivity": "NORMAL",
  "data_delay_threshold": 0,
  "daily_sync_time": "14:00",
  "schedule_type": "auto",
  "connect_card_config": {
    "redirect_uri": "https://your.site/path",
    "hide_setup_guide": true
  },
  "proxy_agent_id": "proxy_agent_id",
  "private_link_id": "private_link_id",
  "networking_method": "Directly",
  "hybrid_deployment_agent_id": "hybrid_deployment_agent_id",
  "destination_configuration": {
    "virtual_warehouse": "virtual_warehouse"
  },
  "destination_schema_names": "SOURCE_NAMING",
  "config": {
    "tunnel_port": 22,
    "password": "test_password",
    "sync_pack_mode": "UNPACKED_MODE | PACKED_MODE",
    "connection_type": "PrivateLink | SshTunnel",
    "port": 27017,
    "host": "documentdbinstance.mycompany.com",
    "tunnel_host": "XXX.XXX.XXX.XXX",
    "always_encrypted": true,
    "user": "test_user",
    "tunnel_user": "fivetran",
    "schema_prefix": "prefix"
  }
}

Config parameters

Name	Description
`tunnel_port`	SSH port, only specify when connecting via an SSH tunnel. Required for connector creation.
`password`	The user's password.
`sync_pack_mode`	Indicates whether synced data will be packed into a single entry(column), or unpacked with one layer of nested fields.
`connection_type`	Possible values:`SshTunnel`, `PrivateLink` . `SshTunnel` is used as a value if this parameter is omitted in the request and the following parameter's values are specified: `tunnel_host`, `tunnel_port`, `tunnel_user`.
`port`	Port of the primary node. Ignored if `hosts` value is provided.
`host`	Host IP address of the primary node. Ignored if `hosts` value is provided.
`tunnel_host`	SSH host, only specify when connecting via an SSH tunnel (do not use a load balancer). Required for connector creation.
`always_encrypted`	Require TLS encryption.
`user`	The user name.
`tunnel_user`	SSH user, specify only to connect via an SSH tunnel. Required for connector creation.
`schema_prefix` (required)	Destination schema prefix. Prefix for each replicated schema. For example with prefix 'x', source schemas 'foo' and 'bar' get replicated as 'x_foo' and 'x_bar'. The prefix is permanent and cannot be changed after connection creation

Authorization

There are two ways to authorize this connector type:

By specifying the values for the host, port, user and password parameters in the request.

POST https://api.fivetran.com/v1/connections

{
  "service": "documentdb",
  "group_id": "group_id",
  "config": {
    "host": "documentdbinstance.mycompany.com",
    "port": 27017,
    "user": "test_user",
    "password": "test_password"
  }
}

By using the Connect Card or the Fivetran dashboard.