Amazon OpenSearch Service

awsSearch indexaws-opensearch

Managed OpenSearch cluster for log analytics, search and observability.

Provider
aws
Category
Data
Also known as
Amazon Elasticsearch Service, Amazon ES
Properties · 4 set by this component
propertytypevaluesrequiredkind defaultthis component
autoTune · component propertyboolean—notrueinherited
dedicatedMasterNodes · component propertyinteger—no3inherited
deploymentOption · component propertyenummulti-az-with-standby | multi-az-without-standby | single-aznomulti-az-with-standbyinherited
encryptionAtRest · component propertyboolean—nofalseinherited
geoScheme · advancedenumnone | s2 | h3 | geohash | quadtreenononeinherited
indexingenumsync | async | batchnoasyncinherited
managedboolean—nofalse▸ true
rebuildCadenceHours · advancedinteger—no—inherited
replicasinteger—no—▸ 1
shardingStrategy · advancedenumnone | hash | geo | time | prefix-rangenonone▸ hash
structureenuminverted | trie | vector | geo-cellnoinverted▸ inverted
Rules that apply · 1

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

derived-store-without-cdc-or-rebuild

A search index is derived data and needs an asynchronous feed from a stream, change data capture or an indexing worker. Without one it is written inline on the request path, and it can never be rebuilt after it drifts.

  • — this does not hold:
  • — the node has at least one asynchronous incoming edge from a stream, change-data-capture or worker
Use it in a design
nodes:
  - { id: "opensearch", component: "aws-opensearch" }
Other Search index products · 31
Source
# yaml-language-server: $schema=../../schema/component.schema.json
# Amazon OpenSearch Service domain: managed OpenSearch cluster that provisions, monitors and replaces its own
# nodes ("What is Amazon OpenSearch Service?"). Easy create builds a Multi-AZ with Standby domain across three
# Availability Zones with three dedicated master nodes, three data nodes and Auto-Tune on, and "the default
# configuration for any index is a replica count of 1" ("Configuring a multi-AZ domain"). Encryption of data at
# rest is selected explicitly ("Encryption of data at rest for Amazon OpenSearch Service").
schemaVersion: "1"
type: "component"
id: "aws-opensearch"
kind: "search-index"
provider: "aws"
docs: "https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html"
aliases: ["Amazon Elasticsearch Service", "Amazon ES"]
defaults:
  managed: true
  structure: "inverted"
  shardingStrategy: "hash"
  replicas: 1
properties:
  deploymentOption:
    type: "enum"
    values: ["multi-az-with-standby", "multi-az-without-standby", "single-az"]
    default: "multi-az-with-standby"
  dedicatedMasterNodes:
    type: "integer"
    default: 3
  encryptionAtRest:
    type: "boolean"
    default: false
  autoTune:
    type: "boolean"
    default: true

The same page as markdown, for an agent: /catalogue/components/aws-opensearch.md