DynamoDB (IAM)

Overview #

A datasource consists of a database resource and the credentials used to access it. This guide describes how to add a DynamoDB (IAM) database as a datasource in the StrongDM Admin UI. This guide covers the configuration of the DynamoDB (IAM) resource type in StrongDM, which uses an EC2-attached IAM role to authenticate with DynamoDB. Once this is set up for the EC2 instances that you intend to use for StrongDM gateways, relays, or proxy cluster workers, your StrongDM users are able to be authenticated to the DynamoDB instance without providing the users or StrongDM with credentials.

If you prefer to use AWS Secret Access Keys instead, see the DynamoDB resource type guide.

Prerequisites #

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

• Properly configure an account for your database resource. If you choose to store credentials for the resource with StrongDM, have those credentials ready. When not using StrongDM, set up a Secret Store integration and be able to enter the location of the secrets required to access the resource.
• 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 443. If your gateway server can connect to this hostname, you can proceed.
  Netcat is a network analysis tool for checking various hostnames and ports by either sending data (a ping) or checking for listeners on ports. The command in the aforementioned example uses the -z flag to check for listeners without sending data and the -v flag to show verbose output. If you do not have Netcat, you can use a package manager such as APT (Advanced Package Tool) to install it. On Linux-based distributions, run apt-get install netcat.

Resource Setup #

In order to connect to and manage the resource, you must define the IAM role you wish to use, with a policy that allows EC2 to assume the role, as in the following example:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {
        "Service": "ec2.amazonaws.com"
      },
      "Action": "sts:AssumeRole"
    }
  ]
}

Then attach a policy to that role that grants access to DynamoDB.

• It is a best practice that this policy contains the minimum required actions necessary for users of this DynamoDB instance to do their work.
• For a resource with role assumption, the "dynamodb:ListGlobalTables", "dynamodb:ListTables", and "dynamodb:ListStreams" actions are the minimum required actions to allow StrongDM to successfully complete healthchecks.
• The wildcard value for Resource is required for the "dynamodb:ListGlobalTables", "dynamodb:ListTables", and "dynamodb:ListStreams" actions to function properly because they are not scoped to a specific resource.

The following is an example of a policy that follows such best practices.

{
"Version": "2012-10-17",
"Statement": [
    {
        "Sid": "Statement1",
        "Effect": "Allow",
        "Action": [
            "dynamodb:ListGlobalTables",
            "dynamodb:ListTables",
            "dynamodb:ListStreams",
            "dynamodb:Scan",
            "dynamodb:GetItem",
            "dynamodb:PutItem",
            "dynamodb:Query",
            "dynamodb:DescribeTable"
        ],
        "Resource": [
            "*"
        ]
    }
]
}

When the EC2 instance is launched, assign the IAM role(s). When the resource is configured with StrongDM, and you have installed your StrongDM gateway, relay, or proxy cluster worker on the EC2 instance, it has the ability to interact with your DynamoDB instance without having to provide credentials to StrongDM.

Add the Resource to StrongDM #

To add your DynamoDB (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 DynamoDB (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 DynamoDB (IAM) database.

Secret Store options #

By default, datasource credentials are stored in StrongDM. However, these credentials can also be saved in a secrets management tool.

Non-StrongDM options appear in the Secret Store dropdown if they are created under Settings > Secrets Management. When you select another Secret Store type, its unique properties display. For more details, see Configure Secret Store Integrations.

Resource status #

After a resource is created, the Admin UI displays that resource as unhealthy until the healthchecks 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.