Advanced parameters for Aiven for OpenSearch®

See the configuration options available for Aiven for OpenSearch®:

Parameter
additional_backup_regions array Additional Cloud Regions for Backup Replication
opensearch_version string,null OpenSearch version
disable_replication_factor_adjustment boolean,null Disable automatic replication factor adjustment for multi-node services. By default, Aiven ensures all indexes are replicated at least to two nodes. Note: Due to potential data loss in case of losing a service node, this setting can not be activated unless specifically allowed for the project.
custom_domain string,null Serve the web frontend using a custom CNAME pointing to the Aiven DNS name. When you set a custom domain for a service deployed in a VPC, the service certificate is only created for the public-* hostname and the custom domain.
custom_repos array Allow to register object storage repositories in OpenSearch
custom_keystores array Allow to register custom keystores in OpenSearch
ip_filter array default: 0.0.0.0/0,::/0 IP filter Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'
service_log boolean,null Service logging Store logs for the service so that they are available in the HTTP API and console.
static_ips boolean Use static public IP addresses
saml object OpenSearch SAML configuration saml.enabled boolean default: true Enable or disable OpenSearch SAML authentication Enables or disables SAML-based authentication for OpenSearch. When enabled, users can authenticate using SAML with an Identity Provider. saml.idp_metadata_url string The URL of the SAML metadata for the Identity Provider (IdP). This is used to configure SAML-based authentication with the IdP. saml.idp_entity_id string The unique identifier for the Identity Provider (IdP) entity that is used for SAML authentication. This value is typically provided by the IdP. saml.sp_entity_id string The unique identifier for the Service Provider (SP) entity that is used for SAML authentication. This value is typically provided by the SP. saml.subject_key string,null Optional. Specifies the attribute in the SAML response where the subject identifier is stored. If not configured, the NameID attribute is used by default. saml.roles_key string,null Optional. Specifies the attribute in the SAML response where role information is stored, if available. Role attributes are not required for SAML authentication, but can be included in SAML assertions by most Identity Providers (IdPs) to determine user access levels or permissions. saml.idp_pemtrustedcas_content string,null This parameter specifies the PEM-encoded root certificate authority (CA) content for the SAML identity provider (IdP) server verification. The root CA content is used to verify the SSL/TLS certificate presented by the server.
openid object OpenSearch OpenID Connect Configuration openid.enabled boolean default: true Enable or disable OpenSearch OpenID Connect authentication Enables or disables OpenID Connect authentication for OpenSearch. When enabled, users can authenticate using OpenID Connect with an Identity Provider. openid.connect_url string The URL of your IdP where the Security plugin can find the OpenID Connect metadata/configuration settings. openid.roles_key string,null The key in the JSON payload that stores the user’s roles. The value of this key must be a comma-separated list of roles. Required only if you want to use roles in the JWT openid.subject_key string,null The key in the JSON payload that stores the user’s name. If not defined, the subject registered claim is used. Most IdP providers use the preferred_username claim. Optional. openid.jwt_header string,null The HTTP header that stores the token. Typically the Authorization header with the Bearer schema: Authorization: Bearer <token>. Optional. Default is Authorization. openid.jwt_url_parameter string,null URL JWT token. If the token is not transmitted in the HTTP header, but as an URL parameter, define the name of the parameter here. Optional. openid.refresh_rate_limit_count integer,null min: 10 max: 9223372036854776000 default: 10 The maximum number of unknown key IDs in the time frame. Default is 10. Optional. openid.refresh_rate_limit_time_window_ms integer,null min: 10000 max: 9223372036854776000 default: 10000 The time frame to use when checking the maximum number of unknown key IDs, in milliseconds. Optional.Default is 10000 (10 seconds). openid.client_id string The ID of the OpenID Connect client configured in your IdP. Required. openid.client_secret string The client secret of the OpenID Connect client configured in your IdP. Required. openid.scope string The scope of the identity token issued by the IdP. Optional. Default is openid profile email address phone. openid.header string default: Authorization HTTP header name of the JWT token. Optional. Default is Authorization.
jwt object OpenSearch JWT Configuration jwt.enabled boolean Enable or disable OpenSearch JWT authentication Enables or disables JWT-based authentication for OpenSearch. When enabled, users can authenticate using JWT tokens. jwt.signing_key string JWT signing key The secret key used to sign and verify JWT tokens. This should be a secure, randomly generated key HMAC key or public RSA/ECDSA key. jwt.jwt_header string,null default: Authorization The HTTP header name where the JWT token is transmitted. Typically 'Authorization' for Bearer tokens. jwt.jwt_url_parameter string,null If the JWT token is transmitted as a URL parameter instead of an HTTP header, specify the parameter name here. jwt.subject_key string,null The key in the JWT payload that contains the user's subject identifier. If not specified, the 'sub' claim is used by default. jwt.roles_key string,null JWT claim key for roles The key in the JWT payload that contains the user's roles. If specified, roles will be extracted from the JWT for authorization. jwt.required_audience string,null Required JWT audience If specified, the JWT must contain an 'aud' claim that matches this value. This provides additional security by ensuring the JWT was issued for the expected audience. jwt.required_issuer string,null Required JWT issuer If specified, the JWT must contain an 'iss' claim that matches this value. This provides additional security by ensuring the JWT was issued by the expected issuer. jwt.jwt_clock_skew_tolerance_seconds integer,null max: 300 default: 20 JWT clock skew tolerance in seconds The maximum allowed time difference in seconds between the JWT issuer's clock and the OpenSearch server's clock. This helps prevent token validation failures due to minor time synchronization issues.
azure_migration object Azure migration settings azure_migration.snapshot_name string The snapshot name to restore from azure_migration.restore_global_state boolean If true, restore the cluster state. Defaults to false azure_migration.include_aliases boolean Include aliases Whether to restore aliases alongside their associated indexes. Default is true. azure_migration.indices string A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. azure_migration.base_path string The path to the repository data within its container. The value of this setting should not start or end with a / azure_migration.compress boolean when set to true metadata files are stored in compressed format azure_migration.chunk_size string Chunk size Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository azure_migration.account string Account name azure_migration.key string Azure account secret key. One of key or sas_token should be specified azure_migration.sas_token string SAS token A shared access signatures (SAS) token. One of key or sas_token should be specified azure_migration.container string Azure container name azure_migration.endpoint_suffix string Endpoint suffix Defines the DNS suffix for Azure Storage endpoints. azure_migration.readonly boolean default: true Whether the repository is read-only.
gcs_migration object Google Cloud Storage migration settings gcs_migration.snapshot_name string The snapshot name to restore from gcs_migration.restore_global_state boolean If true, restore the cluster state. Defaults to false gcs_migration.include_aliases boolean Include aliases Whether to restore aliases alongside their associated indexes. Default is true. gcs_migration.indices string A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. gcs_migration.base_path string The path to the repository data within its container. The value of this setting should not start or end with a / gcs_migration.compress boolean when set to true metadata files are stored in compressed format gcs_migration.chunk_size string Chunk size Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository gcs_migration.bucket string Google Cloud Storage bucket name The path to the repository data within its container gcs_migration.credentials string Google Cloud Storage credentials file content gcs_migration.readonly boolean default: true Whether the repository is read-only.
s3_migration object AWS S3 / AWS S3 compatible migration settings s3_migration.snapshot_name string The snapshot name to restore from s3_migration.restore_global_state boolean If true, restore the cluster state. Defaults to false s3_migration.include_aliases boolean Include aliases Whether to restore aliases alongside their associated indexes. Default is true. s3_migration.indices string A comma-delimited list of indices to restore from the snapshot. Multi-index syntax is supported. s3_migration.base_path string The path to the repository data within its container. The value of this setting should not start or end with a / s3_migration.compress boolean when set to true metadata files are stored in compressed format s3_migration.chunk_size string Chunk size Big files can be broken down into chunks during snapshotting if needed. Should be the same as for the 3rd party repository s3_migration.access_key string AWS Access key s3_migration.secret_key string AWS secret key s3_migration.bucket string S3 bucket name s3_migration.region string S3 region s3_migration.endpoint string The S3 service endpoint to connect to. If you are using an S3-compatible service then you should set this to the service’s endpoint s3_migration.server_side_encryption boolean When set to true files are encrypted on server side s3_migration.readonly boolean default: true Whether the repository is read-only.
index_patterns array Index patterns
max_index_count integer max: 9223372036854776000 Maximum index count DEPRECATED: use index_patterns instead
keep_index_refresh_interval boolean Don't reset index.refresh_interval to the default value 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.
opensearch_dashboards object OpenSearch Dashboards settings opensearch_dashboards.enabled boolean default: true Enable or disable OpenSearch Dashboards opensearch_dashboards.max_old_space_size integer min: 64 max: 4096 default: 128 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. opensearch_dashboards.opensearch_request_timeout integer min: 5000 max: 120000 default: 30000 Timeout in milliseconds for requests made by OpenSearch Dashboards towards OpenSearch opensearch_dashboards.multiple_data_source_enabled boolean default: true Enable or disable multiple data sources in OpenSearch Dashboards
index_rollup object Index rollup settings index_rollup.rollup_search_backoff_millis integer min: 1 plugins.rollup.search.backoff_millis The backoff time between retries for failed rollup jobs. Defaults to 1000ms. index_rollup.rollup_search_backoff_count integer min: 1 plugins.rollup.search.backoff_count How many retries the plugin should attempt for failed rollup jobs. Defaults to 5. index_rollup.rollup_search_search_all_jobs boolean plugins.rollup.search.all_jobs Whether OpenSearch should return all jobs that match all specified search terms. If disabled, OpenSearch returns just one, as opposed to all, of the jobs that matches the search terms. Defaults to false. index_rollup.rollup_dashboards_enabled boolean plugins.rollup.dashboards.enabled Whether rollups are enabled in OpenSearch Dashboards. Defaults to true. index_rollup.rollup_enabled boolean plugins.rollup.enabled Whether the rollup plugin is enabled. Defaults to true.
opensearch object OpenSearch settings opensearch.reindex_remote_whitelist array,null reindex_remote_whitelist Whitelisted addresses for reindexing. Changing this value will cause all OpenSearch instances to restart. opensearch.http_max_content_length integer min: 1 max: 2147483647 http.max_content_length Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. opensearch.http_max_header_size integer min: 1024 max: 262144 http.max_header_size The max size of allowed headers, in bytes opensearch.http_max_initial_line_length integer min: 1024 max: 65536 http.max_initial_line_length The max length of an HTTP URL, in bytes opensearch.indices_query_bool_max_clause_count integer min: 64 max: 4096 indices.query.bool.max_clause_count Maximum number of clauses Lucene BooleanQuery can have. The default value (1024) is relatively high, and increasing it may cause performance issues. Investigate other approaches first before increasing this value. opensearch.search_max_buckets integer,null min: 1 max: 1000000 search.max_buckets Maximum number of aggregation buckets allowed in a single response. OpenSearch default value is used when this is not defined. opensearch.indices_fielddata_cache_size integer,null min: 3 max: 100 indices.fielddata.cache.size Relative amount. Maximum amount of heap memory used for field data cache. This is an expert setting; decreasing the value too much will increase overhead of loading field data; too much memory used for field data cache will decrease amount of heap available for other operations. opensearch.indices_memory_index_buffer_size integer min: 3 max: 40 indices.memory.index_buffer_size Percentage value. Default is 10%. Total amount of heap used for indexing buffer, before writing segments to disk. This is an expert setting. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. opensearch.indices_memory_min_index_buffer_size integer min: 3 max: 2048 indices.memory.min_index_buffer_size Absolute value. Default is 48mb. Doesn't work without indices.memory.index_buffer_size. Minimum amount of heap used for query cache, an absolute indices.memory.index_buffer_size minimal hard limit. opensearch.indices_memory_max_index_buffer_size integer min: 3 max: 2048 indices.memory.max_index_buffer_size Absolute value. Default is unbound. Doesn't work without indices.memory.index_buffer_size. Maximum amount of heap used for query cache, an absolute indices.memory.index_buffer_size maximum hard limit. opensearch.indices_queries_cache_size integer min: 3 max: 40 indices.queries.cache.size Percentage value. Default is 10%. Maximum amount of heap used for query cache. This is an expert setting. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other OpenSearch functionality. opensearch.indices_recovery_max_bytes_per_sec integer min: 40 max: 400 indices.recovery.max_bytes_per_sec Limits total inbound and outbound recovery traffic for each node. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Defaults to 40mb opensearch.indices_recovery_max_concurrent_file_chunks integer min: 2 max: 5 indices.recovery.max_concurrent_file_chunks Number of file chunks sent in parallel for each recovery. Defaults to 2. opensearch.action_auto_create_index_enabled boolean action.auto_create_index Explicitly allow or block automatic creation of indices. Defaults to true opensearch.plugins_alerting_filter_by_backend_roles boolean plugins.alerting.filter_by_backend_roles Enable or disable filtering of alerting by backend roles. Requires Security plugin. Defaults to false opensearch.knn_memory_circuit_breaker_limit integer max: 100 knn.memory.circuit_breaker.limit Maximum amount of memory in percentage that can be used for the KNN index. Defaults to 50% of the JVM heap size. 0 is used to set it to null which can be used to invalidate caches. opensearch.knn_memory_circuit_breaker_enabled boolean Service restart knn.memory.circuit_breaker.enabled Enable or disable KNN memory circuit breaker. Defaults to true. opensearch.auth_failure_listeners object Opensearch Security Plugin Settings opensearch.auth_failure_listeners.internal_authentication_backend_limiting object opensearch.auth_failure_listeners.internal_authentication_backend_limiting.type string internal_authentication_backend_limiting.type The type of rate limiting opensearch.auth_failure_listeners.internal_authentication_backend_limiting.authentication_backend string internal_authentication_backend_limiting.authentication_backend The internal backend. Enter internal opensearch.auth_failure_listeners.internal_authentication_backend_limiting.allowed_tries integer min: 1 max: 32767 internal_authentication_backend_limiting.allowed_tries The number of login attempts allowed before login is blocked opensearch.auth_failure_listeners.internal_authentication_backend_limiting.time_window_seconds integer max: 2147483647 internal_authentication_backend_limiting.time_window_seconds The window of time in which the value for allowed_tries is enforced opensearch.auth_failure_listeners.internal_authentication_backend_limiting.block_expiry_seconds integer max: 2147483647 internal_authentication_backend_limiting.block_expiry_seconds The duration of time that login remains blocked after a failed login opensearch.auth_failure_listeners.internal_authentication_backend_limiting.max_blocked_clients integer max: 2147483647 internal_authentication_backend_limiting.max_blocked_clients The maximum number of blocked IP addresses opensearch.auth_failure_listeners.internal_authentication_backend_limiting.max_tracked_clients integer max: 2147483647 internal_authentication_backend_limiting.max_tracked_clients The maximum number of tracked IP addresses that have failed login opensearch.enable_security_audit boolean Enable/Disable security audit opensearch.enable_snapshot_api boolean Enable/Disable snapshot API for custom repositories, this requires security management to be enabled opensearch.thread_pool_search_size integer min: 1 max: 128 search thread pool size Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. opensearch.thread_pool_search_throttled_size integer min: 1 max: 128 search_throttled thread pool size Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. opensearch.thread_pool_get_size integer min: 1 max: 128 Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. opensearch.thread_pool_analyze_size integer min: 1 max: 128 analyze thread pool size Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. opensearch.thread_pool_write_size integer min: 1 max: 128 write thread pool size Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. opensearch.thread_pool_force_merge_size integer min: 1 max: 128 force_merge thread pool size Size for the thread pool. See documentation for exact details. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value. opensearch.thread_pool_search_queue_size integer min: 10 max: 2000 search thread pool queue size Size for the thread pool queue. See documentation for exact details. opensearch.thread_pool_search_throttled_queue_size integer min: 10 max: 2000 search_throttled thread pool queue size Size for the thread pool queue. See documentation for exact details. opensearch.thread_pool_get_queue_size integer min: 10 max: 2000 Size for the thread pool queue. See documentation for exact details. opensearch.thread_pool_analyze_queue_size integer min: 10 max: 2000 analyze thread pool queue size Size for the thread pool queue. See documentation for exact details. opensearch.thread_pool_write_queue_size integer min: 10 max: 2000 write thread pool queue size Size for the thread pool queue. See documentation for exact details. opensearch.action_destructive_requires_name boolean,null Require explicit index names when deleting opensearch.cluster_max_shards_per_node integer min: 100 max: 10000 cluster.max_shards_per_node Controls the number of shards allowed in the cluster per data node opensearch.override_main_response_version boolean compatibility.override_main_response_version Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default is false opensearch.script_max_compilations_rate string Script max compilation rate - circuit breaker to prevent/minimize OOMs Script compilation circuit breaker limits the number of inline script compilations within a period of time. Default is use-context opensearch.cluster_routing_allocation_node_concurrent_recoveries integer min: 2 max: 16 How many concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen on a node. Defaults to node cpu count * 2. opensearch.email_sender_name string This should be identical to the Sender name defined in Opensearch dashboards opensearch.email_sender_username string Sender username for Opensearch alerts opensearch.email_sender_password string Sender password for Opensearch alerts to authenticate with SMTP server opensearch.ism_enabled boolean Specifies whether ISM is enabled or not opensearch.ism_history_enabled boolean Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. opensearch.ism_history_max_age integer min: 1 max: 2147483647 The maximum age before rolling over the audit history index in hours opensearch.ism_history_max_docs integer min: 1 max: 9223372036854776000 The maximum number of documents before rolling over the audit history index. opensearch.ism_history_rollover_check_period integer min: 1 max: 2147483647 The time between rollover checks for the audit history index in hours. opensearch.ism_history_rollover_retention_period integer min: 1 max: 2147483647 How long audit history indices are kept in days. opensearch.search_backpressure object Search Backpressure Settings opensearch.search_backpressure.mode string The search backpressure mode. Valid values are monitor_only, enforced, or disabled. Default is monitor_only opensearch.search_backpressure.node_duress object Node duress settings opensearch.search_backpressure.node_duress.cpu_threshold number max: 1 The CPU usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.9 opensearch.search_backpressure.node_duress.heap_threshold number max: 1 The heap usage threshold (as a percentage) required for a node to be considered to be under duress. Default is 0.7 opensearch.search_backpressure.node_duress.num_successive_breaches integer min: 1 The number of successive limit breaches after which the node is considered to be under duress. Default is 3 opensearch.search_backpressure.search_task object Search task settings opensearch.search_backpressure.search_task.cancellation_burst number min: 1 The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 5.0 opensearch.search_backpressure.search_task.cancellation_rate number The maximum number of search tasks to cancel per millisecond of elapsed time. Default is 0.003 opensearch.search_backpressure.search_task.cancellation_ratio number max: 1 The maximum number of search tasks to cancel, as a percentage of successful search task completions. Default is 0.1 opensearch.search_backpressure.search_task.cpu_time_millis_threshold integer The CPU usage threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 30000 opensearch.search_backpressure.search_task.elapsed_time_millis_threshold integer The elapsed time threshold (in milliseconds) required for an individual parent task before it is considered for cancellation. Default is 45000 opensearch.search_backpressure.search_task.heap_moving_average_window_size integer The window size used to calculate the rolling average of the heap usage for the completed parent tasks. Default is 10 opensearch.search_backpressure.search_task.heap_percent_threshold number max: 1 The heap usage threshold (as a percentage) required for an individual parent task before it is considered for cancellation. Default is 0.2 opensearch.search_backpressure.search_task.heap_variance number The heap usage variance required for an individual parent task before it is considered for cancellation. A task is considered for cancellation when taskHeapUsage is greater than or equal to heapUsageMovingAverage * variance. Default is 2.0 opensearch.search_backpressure.search_task.total_heap_percent_threshold number max: 1 The heap usage threshold (as a percentage) required for the sum of heap usages of all search tasks before cancellation is applied. Default is 0.5 opensearch.search_backpressure.search_shard_task object Search shard settings opensearch.search_backpressure.search_shard_task.cancellation_burst number min: 1 The maximum number of search tasks to cancel in a single iteration of the observer thread. Default is 10.0 opensearch.search_backpressure.search_shard_task.cancellation_rate number The maximum number of tasks to cancel per millisecond of elapsed time. Default is 0.003 opensearch.search_backpressure.search_shard_task.cancellation_ratio number max: 1 The maximum number of tasks to cancel, as a percentage of successful task completions. Default is 0.1 opensearch.search_backpressure.search_shard_task.cpu_time_millis_threshold integer The CPU usage threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 15000 opensearch.search_backpressure.search_shard_task.elapsed_time_millis_threshold integer The elapsed time threshold (in milliseconds) required for a single search shard task before it is considered for cancellation. Default is 30000 opensearch.search_backpressure.search_shard_task.heap_moving_average_window_size integer The number of previously completed search shard tasks to consider when calculating the rolling average of heap usage. Default is 100 opensearch.search_backpressure.search_shard_task.heap_percent_threshold number max: 1 The heap usage threshold (as a percentage) required for a single search shard task before it is considered for cancellation. Default is 0.5 opensearch.search_backpressure.search_shard_task.heap_variance number The minimum variance required for a single search shard task’s heap usage compared to the rolling average of previously completed tasks before it is considered for cancellation. Default is 2.0 opensearch.search_backpressure.search_shard_task.total_heap_percent_threshold number max: 1 The heap usage threshold (as a percentage) required for the sum of heap usages of all search shard tasks before cancellation is applied. Default is 0.5 opensearch.shard_indexing_pressure object Shard indexing back pressure settings opensearch.shard_indexing_pressure.enabled boolean Enable or disable shard indexing backpressure. Default is false opensearch.shard_indexing_pressure.enforced boolean Run shard indexing backpressure in shadow mode or enforced mode. In shadow mode (value set as false), shard indexing backpressure tracks all granular-level metrics, but it doesn’t actually reject any indexing requests. In enforced mode (value set as true), shard indexing backpressure rejects any requests to the cluster that might cause a dip in its performance. Default is false opensearch.shard_indexing_pressure.primary_parameter object Primary parameter opensearch.shard_indexing_pressure.primary_parameter.node object opensearch.shard_indexing_pressure.primary_parameter.node.soft_limit number Node soft limit Define the percentage of the node-level memory threshold that acts as a soft indicator for strain on a node. Default is 0.7 opensearch.shard_indexing_pressure.primary_parameter.shard object opensearch.shard_indexing_pressure.primary_parameter.shard.min_limit number Shard min limit Specify the minimum assigned quota for a new shard in any role (coordinator, primary, or replica). Shard indexing backpressure increases or decreases this allocated quota based on the inflow of traffic for the shard. Default is 0.001 opensearch.shard_indexing_pressure.operating_factor object Operating factor opensearch.shard_indexing_pressure.operating_factor.lower number Specify the lower occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is below this limit, shard indexing backpressure decreases the current allocated memory for that shard. Default is 0.75 opensearch.shard_indexing_pressure.operating_factor.optimal number Specify the optimal occupancy of the allocated quota of memory for the shard. If the total memory usage of a shard is at this level, shard indexing backpressure doesn’t change the current allocated memory for that shard. Default is 0.85 opensearch.shard_indexing_pressure.operating_factor.upper number Specify the upper occupancy limit of the allocated quota of memory for the shard. If the total memory usage of a shard is above this limit, shard indexing backpressure increases the current allocated memory for that shard. Default is 0.95 opensearch.search.insights.top_queries object opensearch.search.insights.top_queries.cpu object Top N queries monitoring by CPU opensearch.search.insights.top_queries.cpu.enabled boolean Enable or disable top N query monitoring by the metric opensearch.search.insights.top_queries.cpu.top_n_size integer min: 1 Specify the value of N for the top N queries by the metric opensearch.search.insights.top_queries.cpu.window_size string Configure the window size of the top N queries opensearch.search.insights.top_queries.latency object Top N queries monitoring by latency opensearch.search.insights.top_queries.latency.enabled boolean Enable or disable top N query monitoring by the metric opensearch.search.insights.top_queries.latency.top_n_size integer min: 1 Specify the value of N for the top N queries by the metric opensearch.search.insights.top_queries.latency.window_size string Configure the window size of the top N queries opensearch.search.insights.top_queries.memory object Top N queries monitoring by memory opensearch.search.insights.top_queries.memory.enabled boolean Enable or disable top N query monitoring by the metric opensearch.search.insights.top_queries.memory.top_n_size integer min: 1 Specify the value of N for the top N queries by the metric opensearch.search.insights.top_queries.memory.window_size string Configure the window size of the top N queries opensearch.cluster.routing.allocation.balance.prefer_primary boolean cluster.routing.allocation.balance.prefer_primary When set to true, OpenSearch attempts to evenly distribute the primary shards between the cluster nodes. Enabling this setting does not always guarantee an equal number of primary shards on each node, especially in the event of a failover. Changing this setting to false after it was set to true does not invoke redistribution of primary shards. Default is false. opensearch.disk_watermarks object Watermark settings opensearch.disk_watermarks.low integer Low watermark (percentage) The low watermark for disk usage. opensearch.disk_watermarks.high integer The high watermark for disk usage. opensearch.disk_watermarks.flood_stage integer The flood stage watermark for disk usage. opensearch.segrep object Segment Replication Backpressure Settings opensearch.segrep.pressure.enabled boolean segrep.pressure.enabled Enables the segment replication backpressure mechanism. Default is false. opensearch.segrep.pressure.time.limit string default: 5m The maximum amount of time that a replica shard can take to copy from the primary shard. Once segrep.pressure.time.limit is breached along with segrep.pressure.checkpoint.limit, the segment replication backpressure mechanism is initiated. Default is 5 minutes. opensearch.segrep.pressure.checkpoint.limit integer default: 4 The maximum number of indexing checkpoints that a replica shard can fall behind when copying from primary. Once segrep.pressure.checkpoint.limit is breached along with segrep.pressure.time.limit, the segment replication backpressure mechanism is initiated. Default is 4 checkpoints. opensearch.segrep.pressure.replica.stale.limit number max: 1 default: 0.5 The maximum number of stale replica shards that can exist in a replication group. Once segrep.pressure.replica.stale.limit is breached, the segment replication backpressure mechanism is initiated. Default is .5, which is 50% of a replication group. opensearch.cluster.remote_store object opensearch.cluster.remote_store.translog.buffer_interval string The default value of the translog buffer interval used when performing periodic translog updates. This setting is only effective when the index setting index.remote_store.translog.buffer_interval is not present. Defaults to 650ms. opensearch.cluster.remote_store.translog.max_readers integer min: 100 max: 2147483647 Sets the maximum number of open translog files for remote-backed indexes. This limits the total number of translog files per shard. After reaching this limit, the remote store flushes the translog files. Default is 1000. The minimum required is 100. opensearch.cluster.remote_store.state.global_metadata.upload_timeout string The amount of time to wait for the cluster state upload to complete. Defaults to 20s. opensearch.cluster.remote_store.state.metadata_manifest.upload_timeout string The amount of time to wait for the manifest file upload to complete. The manifest file contains the details of each of the files uploaded for a single cluster state, both index metadata files and global metadata files. Defaults to 20s. opensearch.remote_store object opensearch.remote_store.segment.pressure.enabled boolean Enables remote segment backpressure. Default is true opensearch.remote_store.segment.pressure.consecutive_failures.limit integer min: 1 max: 2147483647 The minimum consecutive failure count for activating remote segment backpressure. Defaults to 5. opensearch.remote_store.segment.pressure.bytes_lag.variance_factor number min: 1 The variance factor that is used together with the moving average to calculate the dynamic bytes lag threshold for activating remote segment backpressure. Defaults to 10. opensearch.remote_store.segment.pressure.time_lag.variance_factor number min: 1 The variance factor that is used together with the moving average to calculate the dynamic time lag threshold for activating remote segment backpressure. Defaults to 10. opensearch.cluster.filecache.remote_data_ratio integer,number,null max: 100 Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 0. opensearch.node.search.cache.size string,null Defines a limit of how much total remote data can be referenced as a ratio of the size of the disk reserved for the file cache. This is designed to be a safeguard to prevent oversubscribing a cluster. Defaults to 5gb. Requires restarting all OpenSearch nodes. opensearch.cluster.search.request.slowlog object opensearch.cluster.search.request.slowlog.level string default: trace Log level opensearch.cluster.search.request.slowlog.threshold object opensearch.cluster.search.request.slowlog.threshold.debug string Debug threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1 opensearch.cluster.search.request.slowlog.threshold.info string Info threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1 opensearch.cluster.search.request.slowlog.threshold.trace string Trace threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1 opensearch.cluster.search.request.slowlog.threshold.warn string Warning threshold for total request took time. The value should be in the form count and unit, where unit one of (s,m,h,d,nanos,ms,micros) or -1. Default is -1 opensearch.enable_remote_backed_storage boolean Enable remote-backed storage opensearch.enable_searchable_snapshots boolean Enable searchable snapshots
index_template object Template settings for all new indexes index_template.mapping_nested_objects_limit integer,null max: 100000 (DEPRECATED) index.mapping.nested_objects.limit 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. Deprecated, use an index template instead. index_template.number_of_shards integer,null min: 1 max: 1024 (DEPRECATED) index.number_of_shards The number of primary shards that an index should have. Deprecated, use an index template instead. index_template.number_of_replicas integer,null max: 29 (DEPRECATED) index.number_of_replicas The number of replicas each primary shard has. Deprecated, use an index template instead.
private_access object Allow access to selected service ports from private networks private_access.opensearch boolean Allow clients to connect to opensearch with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations private_access.opensearch_dashboards boolean Allow clients to connect to opensearch_dashboards with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations private_access.prometheus boolean Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations
privatelink_access object Allow access to selected service components through Privatelink privatelink_access.opensearch boolean Enable opensearch privatelink_access.opensearch_dashboards boolean Enable opensearch_dashboards privatelink_access.prometheus boolean Enable prometheus
public_access object Allow access to selected service ports from the public Internet public_access.opensearch boolean Allow clients to connect to opensearch from the public internet for service nodes that are in a project VPC or another type of private network public_access.opensearch_dashboards boolean Allow clients to connect to opensearch_dashboards from the public internet for service nodes that are in a project VPC or another type of private network public_access.prometheus boolean Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network
recovery_basebackup_name string Name of the basebackup to restore in forked service
service_to_fork_from string,null Name of another service to fork from. This has effect only when a new service is being created.
project_to_fork_from string,null Name of another project to fork a service from. This has effect only when a new service is being created.
elasticsearch_version string,null Elasticsearch version