# Amazon Elasticsearch (IAM) ## Overview This guide outlines the configuration steps for adding Amazon OpenSearch/Elasticsearch as a resource in the StrongDM using IAM. 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. Amazon Elasticsearch and Amazon OpenSearch are both supported by StrongDM via this datasource type. We support the following combinations: * Elasticsearch domain with Elasticsearch cluster * OpenSearch domain with Elasticsearch cluster * OpenSearch domain with OpenSearch cluster To use access keys rather than IAM, see the [Amazon ES](https://docs.strongdm.com/admin/resources/datasources/amazon-es) page. To add the resource to StrongDM, you will need the database hostname, port, and a valid set of credentials. Optionally, you can store these credentials in a supported secrets manager and reference them from within StrongDM. The resource's server must be reachable from the selected StrongDM node and configured to accept connections from that node’s IP or network. Use this guide to complete all necessary preparations to add this resource to your StrongDM environment; input the correct properties in the Admin UI, CLI, SDKs, or Terraform provider; and test for a successful connection. When done, you will be able to use the StrongDM Desktop application or CLI to connect to Amazon OpenSearch/Elasticsearch. 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 Amazon Elasticsearch and OpenSearch clusters that are accessible via IAM-based authentication. Clients should use standard Elasticsearch/OpenSearch protocols (such as REST over HTTPS). Some older AWS Elasticsearch implementation versions may not support IAM; confirm compatibility with your cluster. ## 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) deployed in a location that can reach the Elasticsearch/OpenSearch endpoint * 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: * Elasticsearch or OpenSearch domain configured for IAM-based access * Valid IAM role or instance profile attached to the StrongDM node, granting it access to the domain * Required IAM permissions, such as `es:ESHttpGet`, `es:ESHttpPost`, or similar, as defined by AWS for accessing the domain * Network accessibility: ensure security groups, VPC settings, and access policies allow StrongDM nodes to connect ## Resource Setup Some setup is required to prepare an OpenSearch (IAM) resource to receive connections via StrongDM. The AWS administrator needs to add an IAM policy to the EC2 role as in the example shown. Adjust the actions and the resource values based on your own configuration. ```json { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "iam:GetRole", "Resource": "arn:aws:iam::111122223333:role/example-documentdb-iam" }, { "Effect": "Allow", "Action": [ "es:ListDomainNames", "es:DescribeDomain", "es:ESHttpGet", "es:ESHttpPost", "es:ESHttpPut", "es:ESHttpDelete" ], "Resource": "arn:aws:es:eu-central-1:111122223333:domain/example/*" } ] } ``` Then, ensure that in the Amazon OpenSearch Access Policies, the EC2 role is allowed in an access policy, adjusting the example contents to match your own AWS configuration and values: ```json { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "*" }, "Action": "es:*", "Resource": "arn:aws:es:eu-central-1:111122223333:domain/example/*" }, ] } ``` For further help, consult the [OpenSearch IAM documentation](https://docs.aws.amazon.com/OpenSearch/latest/ug/security-iam-OpenSearch.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 Amazon Elasticsearch (IAM) as a resource to StrongDM, use the following steps. 1. Log in to the StrongDM Admin UI. 2. Go to **Resources** > **Managed Resources**. 3. Click **Add Resource**. 4. Select **Amazon ES (IAM)** as the **Resource Type** and set other [configuration properties](#configuration-properties) for your 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 Amazon Elasticsearch (IAM) datasource sdm admin datasources add amazonesiam my-es-domain --endpoint="search-prod-domain.us-west-2.es.amazonaws.com" --region="us-west-2" --port="443" --bind-interface="127.0.0.1" --port-override="-1" --proxy-cluster-id="n-1a2b345c67890123" --egress-filter="tag:environment=prod" --secret-store-id="se-e1b2" --subdomain="es-prod" --tags="env=production,team=search" --no-tls-required --ca-cert="/path/to/ca.pem" --client-cert="/path/to/client.crt" --client-key="/path/to/client.key" --timeout="30s" ``` {% 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 Amazon ES (IAM) resource resource "sdm_amazonesiam" "es_prod" { name = "es-iam-prod" endpoint = "search-prod-domain.us-west-2.es.amazonaws.com" region = "us-west-2" port = 443 # Networking / node routing bind_interface = "127.0.0.1" egress_filter = "tag:environment=prod" port_override = 12345 proxy_cluster_id = "n-1a2b345c67890123" # Secrets / metadata secret_store_id = "se-e1b2" subdomain = "es-prod" tags = { env = "production" team = "search" region = "west" } # TLS (recommended) tls_required = true # Optional certificate pinning / client auth (include only if needed) # ca_cert = file("ca.crt") # client_cert = file("client.crt") # client_key = file("client.key") } ``` {% 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 Amazon Elasticsearch (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 | **Amazon ES (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 | | **Endpoint** | Required | API server endpoint of the resource in the format `..es.amazonaws.com`, such as `A95FBC180B680B58A6468EF360D16E96.yl4.us-west-2.es.amazonaws.com`; StrongDM node should be able to [connect to your ES endpoint](#prerequisites) | | **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`) | | **Region** | Required | AWS region (for example, `us-east-1`) | | **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 | | **TLS Required** | Optional | When selected, requires TLS for connections to this resource | | **Assume Role 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) functionality | | **Assume Role External ID** | Optional | External ID role to assume after login (for example `12345`) | | **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** > **Secret Stores**. 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 Elasticsearch (IAM) resource appears in your list of accessible datasources. 3. Start a session to the resource, as in the following example: ```bash sdm connect es-iam-prod ``` This prepares your local environment to route traffic through StrongDM to the Elasticsearch/OpenSearch domain. See the CLI Reference documentation for details on [sdm connect](https://app.gitbook.com/s/4XOJmXFslCMVCzIG2rKp/cli/connect). 4. Use your preferred client (for example, `curl`, Postman, or an Elasticsearch/OpenSearch tool) to request cluster health. If you configured a **Subdomain** (for example, `es-prod`), you can use it directly; otherwise, use the endpoint you entered in the resource. ```bash # If using the StrongDM subdomain: curl -s https://es-prod..sdm.network/_cluster/health | jq . # Example if using the AWS domain you configured: curl -s https://search-prod-domain.us-west-2.es.amazonaws.com/_cluster/health | jq . ``` You should see one or more namespaces returned if connectivity and auth are working. 5. In the StrongDM Admin UI, check **Logs > Queries** (and **Logs > Connections**) to verify your session and commands were captured. 6. If you set **TLS required** on the resource, confirm that the connection negotiates TLS successfully. Mismatched certificate authority or client certs or hostname issues will surface as handshake errors. 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/amazon-es-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.