DocumentDB (single host IAM)

Last modified on January 22, 2025

Overview

A datasource consists of a database resource and the credentials used to access it. This guide describes how to add a DocumentDB (single host IAM) database as a datasource in the StrongDM Admin UI.

Prerequisites

To add a datasource, make sure you have met the following prerequisites:

  • Your DocumentDB cluster should be configured and ready for use.
  • Your AWS IAM role should be configured and ready for use.
  • Ideally, you should test connecting to the cluster using IAM and the credentials you intend to use to configure StrongDM, to discover and solve any configuration issues prior to setting up connection with StrongDM.
  • The hostname or endpoint you enter for your resource must be accessible by at least one gateway or relay. To verify this, log in to the gateway or relay and use the nc -zv <YOUR_HOSTNAME> <YOUR_PORT> Netcat command. For example, use nc -zv testdb-01.fancy.org 5432. If your gateway server can connect to this hostname, you can proceed.

Resource Setup

Your DocumentDB database should be set up for IAM role authentication prior to using StrongDM to connect to it. This is typically done through attaching an IAM role to an EC2 instance and then adding a user to the DocumentDB database that uses that role. That user is the one that is added in the Username and Password StrongDM resource properties. See the AWS DocumentDB IAM Guide for more details.

Add a Datasource

To add your new DocumentDB (single host IAM) database as a StrongDM datasource, use the following steps.

  1. Log in to the StrongDM Admin UI.
  2. Go to Resources > Datasources.
  3. Click Add datasource.
  4. Select DocumentDB (single host IAM) as the Datasource Type and set other configuration properties for your new database resource.
  5. Complete all required fields.
  6. Click Create to save the resource.
  7. Click the resource name to view status, diagnostic information, and setting details.

Resource properties

Configuration properties are visible when you add a datasource or when you click to view its settings. The following table describes the settings available for your DocumentDB (single host IAM) database.

PropertyRequirementDescription
Display NameRequiredMeaningful name to display the resource throughout StrongDM; exclude special characters like quotes (") or angle brackets (< or >)
Datasource TypeRequiredSelect DocumentDB (single host IAM)
HostnameRequiredHostname for your DocumentDB (single host IAM) resource; must be accessible to a gateway or relay
PortRequiredPort to use when connecting to your DocumentDB (single host IAM) database; default port value is 5432
Bind InterfaceRead onlyAutomatically generated IP address value in the 127.0.0.1 to 127.255.255.254 IP address range; default is 127.0.0.1; preferred bind interface value can be modified later under Settings > Port Overrides
Port OverrideRead onlyAutomatically generated with a value between 1024-59999 as long as that port is not used by another resource; preferred port can be modified later under Settings > Port Overrides
RegionRequiredRegion of the resource, such as us-west-1
Resource TagsOptionalDatasource tags consisting of key-value pairs <KEY>=<VALUE> (for example, env=dev)

Resource status

After a resource is created, the Admin UI displays that resource as unhealthy until the health checks run successfully. When the resource is ready, the Health icon indicates a positive, green status.

When the resource does not display a positive status, click the resource name to go to the Diagnostics tab and check for errors.

Test the Connection

After you have created the DocumentDB datasource, you can use the MongoDB Shell to test the connection to DocumentDB.

  1. Run the following command to connect to the instance running on your localhost:
    mongosh "mongodb://localhost:<PORT>/admin"

    Example:
    mongosh "mongodb://localhost:37018/admin"

  2. Once connected, execute the following command to see the databases:
    show dbs

Top