# Aurora MySQL (IAM) ## Overview This guide explains how to add an Aurora MySQL database in StrongDM using AWS IAM for authentication. When the resource is added, StrongDM proxies client connections through a [node](https://docs.strongdm.com/admin/networking/gateways-and-relays) (gateway, relay, or proxy cluster). This enables centralized access control, credential management, and audit logging. Use this guide to complete IAM setup on your node, fill in the required properties (including the S3 query results location), and test connectivity. For general information about how to add a database as a resource in StrongDM, see our main guide, [Add a Datasource](https://docs.strongdm.com/admin/resources/datasources). ## Supported Versions and Clients StrongDM supports Aurora MySQL clusters running MySQL-compatible engines that are configured for IAM database authentication. Any standard MySQL client or library can connect through StrongDM, including: * `mysql` and `mysqlsh` CLI clients * GUI tools like MySQL Workbench or DBeaver * Application frameworks using MySQL drivers {% hint style="info" %} IAM authentication must be enabled on your Aurora MySQL cluster. Ensure your Aurora engine version supports IAM DB auth (MySQL 5.6+, 5.7+, or 8.0+ depending on Aurora release). {% endhint %} ## Prerequisites To add your resource in StrongDM, you need to meet several technical and configuration prerequisites. Please ensure that the following requirements are met. In StrongDM, you must have the following: * Administrator permission level * At least one operational StrongDM node (gateway, relay, or proxy cluster) that can reach the Aurora cluster endpoint and port (default: `3306`) * If using secrets management tools for storing your credentials, a Secret Store configured in StrongDM {% hint style="info" %} To verify that the resource is accessible by the node, log in to the gateway or relay and use Netcat: `nc -zv ` (in this example, `nc -zv testdb-01.fancy.org 3306`). If your gateway server can connect to this hostname, proceed. Netcat is a tool for checking various hostnames and ports by either sending data (a ping) or checking for listeners on the ports. The command in the aforementioned example use "-z" to check for listeners without sending data and "-v" to show verbose output. If you don't have Netcat, you can install the Netcat package with whatever package manager you are using, such as "apt-get install netcat". {% endhint %} On the AWS side, you must have the following: * Aurora MySQL cluster with IAM database authentication enabled * Database user created with the `IDENTIFIED WITH AWSAuthenticationPlugin` clause * IAM role or IAM user with: * `rds-db:connect` permissions for the DB resource * AWS permissions to generate database tokens (`rds:GenerateDbAuthToken`) * Correct security groups/VPC settings so StrongDM nodes can connect to the cluster endpoint ## Resource Setup Some setup steps are required to prepare an Aurora MySQL (IAM) resource to receive connections via StrongDM. 1. The AWS administrator should enable IAM authentication for the target MySQL resource in the AWS Management Console. This can be done at creation, or be modified at a later time. This is done by locating the **Database authentication** setting and choosing the option **Password and IAM database authentication**. 2. A MySQL administrator needs to log in to the database and create a user for use with StrongDM. For example: `CREATE USER db_userx IDENTIFIED WITH AWSAuthenticationPlugin AS 'RDS';` 3. Finally, the AWS administrator needs to add an IAM policy to the IAM role that is attached to the gateway or relay to allow access, as in the example shown. ```json { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "rds-db:connect" ], "Resource": [ "arn:aws:rds-db:us-east-2:1234567890:dbuser:cluster-ABCDEFGHIJKL01234/db_userx" ] } ] } ``` For further help, consult the [Aurora IAM documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.DBAccounts.html). ## Resource Management in StrongDM After all prerequisites and prep work is done, you are ready to add the resource to StrongDM. This section provides instructions for adding the resource in either the StrongDM Admin UI, CLI, Terraform provider, or SDKs. {% tabs %} {% tab title="Admin UI" %} **Set up and Manage With the Admin UI** If using the Admin UI to add an Aurora MySQL (IAM) database as a StrongDM resource, use the following steps. 1. Log in to the StrongDM Admin UI. 2. Go to **Resources** > **Managed Resources**. 3. Click **Add Resource**. 4. Select **Aurora MySQL (IAM)** as the **Resource Type** and set other [configuration properties](#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](#resource-status), diagnostic information, and setting details. {% endtab %} {% tab title="CLI" %} **Set up and Manage With the CLI** This section provides an example of how to configure and manage the resource using the StrongDM CLI. For more information and examples, please see the [CLI Reference](https://app.gitbook.com/s/4XOJmXFslCMVCzIG2rKp/cli) documentation. ``` # Add Aurora MySQL (IAM) datasource sdm admin datasources add auroramysqliam aurora-mysql-iam-prod --hostname="mydb-cluster.cluster-abcdefghijkl.us-east-1.rds.amazonaws.com" --port=3306 --database="production" --region="us-east-1" --username="iam_db_user" --role-arn="arn:aws:iam::123456789012:role/AuroraDBRole" --role-external-id="optional-external-id" --tls-required --bind-interface="127.0.0.1" --egress-filter="tag:env=prod" --port-override="-1" --proxy-cluster-id="n-1a2b345c67890123" --secret-store-id="se-e1b2" --subdomain="aurora-iam-prod" --tags="env=production,team=data" ``` {% endtab %} {% tab title="Terraform" %} **Set up and Manage With Terraform** This section provides an example of how to configure and manage the resource using the Terraform provider. For more information and examples, please see the [Terraform provider](https://github.com/strongdm/terraform-provider-sdm) documentation. ``` # Install StrongDM provider terraform { required_providers { sdm = { source = "strongdm/sdm" version = "16.5.0" } } } # Configure StrongDM provider provider "sdm" { # Add API access key and secret key from Admin UI api_access_key = "njjSn...5hM" api_secret_key = "ziG...=" } # Create Aurora MySQL (IAM) resource resource "sdm_auroramysqliam" "aurora_prod" { name = "aurora-mysql-iam-prod" hostname = "mydb-cluster.cluster-abcdefghijkl.us-east-1.rds.amazonaws.com" port = 3306 database = "production" region = "us-east-1" username = "iam_db_user" # IAM options role_arn = "arn:aws:iam::123456789012:role/AuroraDBRole" role_external_id = "optional-external-id" # Alternative: # access_key_id = "AKIAEXAMPLE" # secret_access_key = "secretKeyExample123" # Networking / routing tls_required = true bind_interface = "127.0.0.1" egress_filter = "tag:env=prod" port_override = 12345 proxy_cluster_id = "n-1a2b345c67890123" # Secrets / metadata secret_store_id = "se-e1b2" subdomain = "aurora-iam-prod" tags = { env = "production" team = "data" } } ``` {% endtab %} {% tab title="SDKs" %} **Set up and manage with SDKs** In addition to the Admin UI, CLI, and Terraform, you may configure and manage your resource with any of the following SDK options: Go, Java, Python, and Ruby. Please see the following references for more information and examples. | Language | Reference | GitHub | Examples | | ------------- | ------------------------------------------------------------------------ | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------- | | Go | [pkg.go.dev](https://pkg.go.dev/github.com/strongdm/strongdm-sdk-go/v16) | [strongdm-sdk-go](https://github.com/strongdm/strongdm-sdk-go) | [Go SDK Examples](https://github.com/strongdm/strongdm-sdk-go-examples) | | Java | [javadoc](https://strongdm.github.io/strongdm-sdk-java-docs/) | [strongdm-sdk-java](https://github.com/strongdm/strongdm-sdk-java) | [Java SDK Examples](https://github.com/strongdm/strongdm-sdk-java-examples) | | Python | [pdocs](https://strongdm.github.io/strongdm-sdk-python-docs/) | [strongdm-sdk-python](https://github.com/strongdm/strongdm-sdk-python) | [Python SDK Examples](https://github.com/strongdm/strongdm-sdk-python-examples) | | Ruby | [RubyDoc](https://www.rubydoc.info/gems/strongdm) | [strongdm-sdk-ruby](https://github.com/strongdm/strongdm-sdk-ruby) | [Ruby SDK Examples](https://github.com/strongdm/strongdm-sdk-ruby-examples) | | {% endtab %} | | | | | {% endtabs %} | | | | ## **Configuration Properties** The following configuration properties are required to define an Athena (IAM) datasource in StrongDM. These settings control how StrongDM connects to the resource, authenticates the connection, and optionally uses encryption or secret management. Each property must be correctly configured to ensure connectivity and access enforcement through StrongDM. | Property | Requirement | Description | | ------------------------ | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Display Name** | Required | Meaningful name to display the resource throughout StrongDM; exclude special characters like quotes (") or angle brackets (< or >) | | **Resource Type** | Required | **Aurora MySQL (IAM)** | | **Proxy Cluster** | Required | Defaults to "None (use gateways)"; if using [proxy clusters](https://docs.strongdm.com/admin/networking/proxy-clusters), select the appropriate cluster to proxy traffic to this resource | | **Hostname** | Required | Hostname for your resource; [must be accessible](#prerequisites) to a gateway or relay | | **Port** | Required | Port to use when connecting to your Aurora MySQL (IAM) database; default port value is **3306** | | **Connectivity Mode** | Required | Select either **Virtual Networking Mode**, which lets users connect to the resource with a software-defined, IP-based network; or **Loopback Mode**, which allows users to connect to the resource using the local loopback adapter in their operating system; this field is shown if [Virtual Networking Mode](https://docs.strongdm.com/admin/clients/client-networking/virtual-networking-mode) enabled for your organization | | **IP Address** | Optional | If **Virtual Networking Mode** is the selected connectivity mode, an IP address value in the configured Virtual Networking Mode subnet in the organization network settings; if **Loopback Mode** is the selected connectivity mode, an IP address value in the configured Loopback IP range in the organization network settings (by default, `127.0.0.1`); if not specified, an available IP address in the configured IP address space for the selected connectivity mode will be automatically assigned; this field is shown if [Virtual Networking Mode](https://docs.strongdm.com/admin/clients/client-networking/virtual-networking-mode) and/or [multi-loopback mode](https://docs.strongdm.com/admin/clients/client-networking/loopback-ip-ranges) is enabled for your organization | | **Port Override** | Optional | If **Virtual Networking Mode** is the selected connectivity mode, a port value between 1 and 65535 that is not already in use by another resource with the same IP address; if **Loopback Mode** is the selected connectivity mode, a port value between 1024 to 64999 that is not already in use by another resource with the same IP address; when left empty with Virtual Networking Mode, the system assigns the default port to this resource; when left empty for Loopback Mode, an available port that is not already in use by another resource is assigned; preferred port also can be modified later from the [Port Overrides settings](https://docs.strongdm.com/admin/resources/port-overrides) | | **DNS** | Optional | If Virtual Networking Mode is the selected connectivity mode, a unique hostname alias for this resource; when set, causes the desktop app to display this resource's human-readable DNS name (for example, `k8s.my-organization-name`) instead of the bind address that includes IP address and port (for example, `100.64.100.100:5432`) | | **Healthcheck Database** | Optional | Database name you would like to connect to specifically for healthchecks from StrongDM | | **Secret Store** | Optional | Credential store location; defaults to none (credentials are stored in StrongDM resource configuration); learn more about [Secret Store](#secret-store-options) options | | **Username** | Required | Username to utilize when connecting to this datasource; displays when Secret Store integration is not configured for your organization or when StrongDM serves as the secret store | | **Username (path)** | Required | Path to the secret in your Secret Store location (for example, `path/to/credential?key=optionalKeyName` where key argument is optional); required when using a non-StrongDM Secret Store type | | **Region** | Required | AWS region to connect to (for example, `us-west-2`) | | **Role Assumption ARN** | Optional | Role ARN, such as `arn:aws:iam::000000000000:role/RoleName`, that allows users accessing this resource to assume a role using [AWS AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) | | **Resource Tags** | Optional | Datasource [Tags](https://app.gitbook.com/s/4XOJmXFslCMVCzIG2rKp/cli/tags "mention") consisting of key-value pairs `=` (for example, `env=dev`) | ### 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](https://docs.strongdm.com/admin/access/secret-stores). ### 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. ## Test the Connection After you have added your resource in StrongDM, follow these steps to verify that it’s working correctly. 1. Assign yourself access by ensuring that your user or role has access to the resource. In the StrongDM Admin UI, go to **Access** > **Roles**, and verify that the resource is attached to a role you’re in. 2. In the CLI, run `sdm status` to list the available datasources. Ensure that the Aurora resource appears in your list of accessible datasources. 3. Start a session to the resource, as in the following example: ```bash sdm connect aurora-mysql-iam-prod ``` \ This sets local environment variables (such as `MYSQL_HOST`, `MYSQL_PORT`, and so forth) for connecting. See the CLI Reference documentation for details on [sdm connect](https://app.gitbook.com/s/4XOJmXFslCMVCzIG2rKp/cli/connect). 4. Use the MySQL CLI or GUI to connect, as in the following example: ```bash mysql -h $MYSQL_HOST -P $MYSQL_PORT -u $MYSQL_USER -p$MYSQL_PASSWORD $MYSQL_DATABASE ``` \ Run a simple query to confirm: ```bash SELECT NOW(); ``` 5. In the StrongDM Admin UI, check **Logs > Queries** (and **Logs > Connections**) to confirm the session and statements were captured. When these steps succeed, you’re ready to connect to your resource through StrongDM. ### Help If you encounter issues, please consult the [StrongDM Help Center](https://help.strongdm.com/hc/en-us). Be prepared to provide the following information to StrongDM Support, so that they can inspect logs and confirm node and resource health: * Resource name or ID * CLI error output or logs * Node name and region * Timestamps of failed attempts --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.strongdm.com/admin/resources/datasources/aurora-mysql-iam.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.