Skip to main content

AWS OpenSearch Connector - Search Infrastructure

Description​

This connector demonstrates integration with AWS OpenSearch (formerly Elasticsearch) for advanced search capabilities. Unlike REST API connectors, this uses the specialized amazon_opensearch type with AWS IAM authentication. It shows how to configure search infrastructure with environment-specific index prefixing, AWS credentials, and endpoint management. This pattern is essential for implementing full-text search, analytics, and log aggregation in Stack9 applications.

Use Case​

Used in a lottery/donation CRM system to provide powerful search capabilities across customer records, subscriptions, transactions, and communications. The connector enables instant search results, faceted filtering, and analytics dashboards. The environment-specific index prefixing ensures data isolation between development, staging, and production environments.

Key Features​

  • AWS IAM authentication with access keys
  • Environment-specific index prefixing for data isolation
  • Specialized OpenSearch connector type
  • Secure credential management through environment variables
  • Direct endpoint configuration
  • Automatic index management per environment

JSON Definition​

{
  "name": "OpenSearch",
  "key": "opensearch",
  "description": "OpenSearch",
  "configuration": {
    "accessKeyId": "%%awsOpenSearchAccessKeyId%%",
    "secretAccessKeyId": "%%awsOpenSearchSecretAccessKeyId%%",
    "endpoint": "%%awsOpenSearchEndpoint%%",
    "prefixIndexWithEnvironment": true
  },
  "type": "amazon_opensearch"
}

Notes​

  • The amazon_opensearch type provides specialized OpenSearch functionality
  • prefixIndexWithEnvironment: true automatically prefixes indexes with env name
  • AWS IAM credentials provide secure access control
  • The endpoint should include the full OpenSearch domain URL
  • This connector type handles AWS signature version 4 authentication automatically
  • Index prefixing prevents data leakage between environments
  • Supports all OpenSearch operations: indexing, searching, aggregations, etc.