DBaaS Service Opensearch

Properties

Property	Type	Required	Description
`name`	string	yes	Service name
`plan`	string	yes	Subscription plan
`prometheus-uri`	Prometheus URI	yes	Prometheus integration URI
`type`	string	yes	Service type code
`backups`	array of List of backups for the service	no	List of backups for the service
`components`	array of Components	no	Service component information objects
`connection-info`	Connection Info	no	Opensearch connection information properties
`created-at`	string	no	Service creation timestamp (ISO 8601)
`description`	string	no	DbaaS service description
`disk-size`	integer	no	TODO UNIT disk space for data storage
`index-patterns`	array of Index Patterns	no	Allows you to create glob style patterns and set a max number of indexes matching this pattern you want to keep. Creating indexes exceeding this value will cause the oldest one to get deleted. You could for example create a pattern looking like ’logs.?’ and then create index logs.1, logs.2 etc, it will delete logs.1 once you create logs.6. Do note ’logs.?’ does not apply to logs.10. Note: Setting max_index_count to 0 will do nothing and the pattern gets ignored.
`index-template`	Index Template	no	Template settings for all new indexes
`integrations`	array of DBaaS Integration	no	Service integrations
`ip-filter`	array[string]	no	Allowed CIDR address blocks for incoming connections
`keep-index-refresh-interval`	boolean	no	Aiven automation resets index.refresh_interval to default value for every index to be sure that indices are always visible to search. If it doesn’t fit your case, you can disable this by setting up this flag to true.
`maintenance`	Automatic maintenance settings	no	Automatic maintenance settings
`max-index-count`	integer	no	Maximum number of indexes to keep before deleting the oldest one
`node-count`	integer	no	Number of service nodes in the active plan
`node-cpu-count`	integer	no	Number of CPUs for each node
`node-memory`	integer	no	TODO UNIT of memory for each node
`node-states`	array of Automatic maintenance settings	no	State of individual service nodes
`notifications`	array of Service notifications	no	Service notifications
`opensearch-dashboards`	Opensearch Dashboards	no	OpenSearch Dashboards settings
`opensearch-settings`	OpenSearch settings	no	OpenSearch-specific settings
`state`	string	no	State of the service Allowed values: `running`, `rebuilding`, `rebalancing`, `poweroff`.
`termination-protection`	boolean	no	Service is protected against termination and powering off
`updated-at`	string	no	Service last update timestamp (ISO 8601)
`uri`	string	no	URI for connecting to the service (may be absent)
`uri-params`	object	no	service_uri parameterized into key-value pairs
`users`	array of Users	no	List of service users
`version`	string	no	OpenSearch version
`zone`	string	no	The zone where the service is running

Connection Info

Opensearch connection information properties

Property	Type	Required
`dashboard-uri`	string	no
`password`	string	no
`uri`	array[string]	no
`username`	string	no

Prometheus URI

Prometheus integration URI

Property	Type	Required	Description
`host`	string	no
`port`	integer	no

Components

Property	Type	Required	Description
`component`	string	yes	Service component name
`host`	string	yes	DNS name for connecting to the service component
`port`	integer	yes	Port number for connecting to the service component
`route`	string	yes	Network access route Allowed values: `dynamic`, `private`, `public`, `privatelink`.
`usage`	string	yes	DNS usage name Allowed values: `primary`, `replica`.

Index Patterns

Property	Type	Required	Description
`max-index-count`	integer	no	Maximum number of indexes to keep
`pattern`	string	no	fnmatch pattern
`sorting-algorithm`	string	no	Deletion sorting algorithm Allowed values: `alphabetical`, `creation_date`.

Index Template

Template settings for all new indexes

Property	Type	Required	Description
`mapping-nested-objects-limit`	integer	no	The maximum number of nested JSON objects that a single document can contain across all nested types. This limit helps to prevent out of memory errors when a document contains too many nested objects. Default is 10000.
`number-of-replicas`	integer	no	The number of replicas each primary shard has.
`number-of-shards`	integer	no	The number of primary shards that an index should have.

Opensearch Dashboards

OpenSearch Dashboards settings

Property	Type	Required	Description
`enabled`	boolean	no	Enable or disable OpenSearch Dashboards (default: true)
`max-old-space-size`	integer	no	Limits the maximum amount of memory (in MiB) the OpenSearch Dashboards process can use. This sets the max_old_space_size option of the nodejs running the OpenSearch Dashboards. Note: the memory reserved by OpenSearch Dashboards is not available for OpenSearch. (default: 128)
`opensearch-request-timeout`	integer	no	Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch (default: 30000)

Users

Property	Type	Required
`password`	string	no
`type`	string	no
`username`	string	no

Last updated on February 13, 2026