digitalocean.DatabaseOpensearchConfig
Explore with Pulumi AI
Provides a virtual resource that can be used to change advanced configuration options for a DigitalOcean managed Opensearch database cluster.
Note Opensearch configurations are only removed from state when destroyed. The remote configuration is not unset.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";
const exampleDatabaseCluster = new digitalocean.DatabaseCluster("example", {
    name: "example-opensearch-cluster",
    engine: "opensearch",
    version: "2",
    size: digitalocean.DatabaseSlug.DB_1VPCU2GB,
    region: digitalocean.Region.NYC3,
    nodeCount: 1,
});
const example = new digitalocean.DatabaseOpensearchConfig("example", {
    clusterId: exampleDatabaseCluster.id,
    ismEnabled: true,
    ismHistoryEnabled: true,
    ismHistoryMaxAgeHours: 24,
    ismHistoryMaxDocs: 2500000,
    ismHistoryRolloverCheckPeriodHours: 8,
    ismHistoryRolloverRetentionPeriodDays: 30,
    httpMaxContentLengthBytes: 100000000,
    httpMaxHeaderSizeBytes: 8192,
    httpMaxInitialLineLengthBytes: 4096,
    indicesQueryBoolMaxClauseCount: 1024,
    searchMaxBuckets: 10000,
    indicesFielddataCacheSizePercentage: 3,
    indicesMemoryIndexBufferSizePercentage: 10,
    indicesMemoryMinIndexBufferSizeMb: 48,
    indicesMemoryMaxIndexBufferSizeMb: 3,
    indicesQueriesCacheSizePercentage: 10,
    indicesRecoveryMaxMbPerSec: 40,
    indicesRecoveryMaxConcurrentFileChunks: 2,
    actionAutoCreateIndexEnabled: true,
    actionDestructiveRequiresName: false,
    enableSecurityAudit: false,
    threadPoolSearchSize: 1,
    threadPoolSearchThrottledSize: 1,
    threadPoolSearchThrottledQueueSize: 10,
    threadPoolSearchQueueSize: 10,
    threadPoolGetSize: 1,
    threadPoolGetQueueSize: 10,
    threadPoolAnalyzeSize: 1,
    threadPoolAnalyzeQueueSize: 10,
    threadPoolWriteSize: 1,
    threadPoolWriteQueueSize: 10,
    threadPoolForceMergeSize: 1,
    overrideMainResponseVersion: false,
    scriptMaxCompilationsRate: "use-context",
    clusterMaxShardsPerNode: 100,
    clusterRoutingAllocationNodeConcurrentRecoveries: 2,
    pluginsAlertingFilterByBackendRolesEnabled: false,
    reindexRemoteWhitelists: ["cloud.digitalocean.com:8080"],
});
import pulumi
import pulumi_digitalocean as digitalocean
example_database_cluster = digitalocean.DatabaseCluster("example",
    name="example-opensearch-cluster",
    engine="opensearch",
    version="2",
    size=digitalocean.DatabaseSlug.D_B_1_VPCU2_GB,
    region=digitalocean.Region.NYC3,
    node_count=1)
example = digitalocean.DatabaseOpensearchConfig("example",
    cluster_id=example_database_cluster.id,
    ism_enabled=True,
    ism_history_enabled=True,
    ism_history_max_age_hours=24,
    ism_history_max_docs=2500000,
    ism_history_rollover_check_period_hours=8,
    ism_history_rollover_retention_period_days=30,
    http_max_content_length_bytes=100000000,
    http_max_header_size_bytes=8192,
    http_max_initial_line_length_bytes=4096,
    indices_query_bool_max_clause_count=1024,
    search_max_buckets=10000,
    indices_fielddata_cache_size_percentage=3,
    indices_memory_index_buffer_size_percentage=10,
    indices_memory_min_index_buffer_size_mb=48,
    indices_memory_max_index_buffer_size_mb=3,
    indices_queries_cache_size_percentage=10,
    indices_recovery_max_mb_per_sec=40,
    indices_recovery_max_concurrent_file_chunks=2,
    action_auto_create_index_enabled=True,
    action_destructive_requires_name=False,
    enable_security_audit=False,
    thread_pool_search_size=1,
    thread_pool_search_throttled_size=1,
    thread_pool_search_throttled_queue_size=10,
    thread_pool_search_queue_size=10,
    thread_pool_get_size=1,
    thread_pool_get_queue_size=10,
    thread_pool_analyze_size=1,
    thread_pool_analyze_queue_size=10,
    thread_pool_write_size=1,
    thread_pool_write_queue_size=10,
    thread_pool_force_merge_size=1,
    override_main_response_version=False,
    script_max_compilations_rate="use-context",
    cluster_max_shards_per_node=100,
    cluster_routing_allocation_node_concurrent_recoveries=2,
    plugins_alerting_filter_by_backend_roles_enabled=False,
    reindex_remote_whitelists=["cloud.digitalocean.com:8080"])
package main
import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDatabaseCluster, err := digitalocean.NewDatabaseCluster(ctx, "example", &digitalocean.DatabaseClusterArgs{
			Name:      pulumi.String("example-opensearch-cluster"),
			Engine:    pulumi.String("opensearch"),
			Version:   pulumi.String("2"),
			Size:      pulumi.String(digitalocean.DatabaseSlug_DB_1VPCU2GB),
			Region:    pulumi.String(digitalocean.RegionNYC3),
			NodeCount: pulumi.Int(1),
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewDatabaseOpensearchConfig(ctx, "example", &digitalocean.DatabaseOpensearchConfigArgs{
			ClusterId:                                        exampleDatabaseCluster.ID(),
			IsmEnabled:                                       pulumi.Bool(true),
			IsmHistoryEnabled:                                pulumi.Bool(true),
			IsmHistoryMaxAgeHours:                            pulumi.Int(24),
			IsmHistoryMaxDocs:                                pulumi.Int(2500000),
			IsmHistoryRolloverCheckPeriodHours:               pulumi.Int(8),
			IsmHistoryRolloverRetentionPeriodDays:            pulumi.Int(30),
			HttpMaxContentLengthBytes:                        pulumi.Int(100000000),
			HttpMaxHeaderSizeBytes:                           pulumi.Int(8192),
			HttpMaxInitialLineLengthBytes:                    pulumi.Int(4096),
			IndicesQueryBoolMaxClauseCount:                   pulumi.Int(1024),
			SearchMaxBuckets:                                 pulumi.Int(10000),
			IndicesFielddataCacheSizePercentage:              pulumi.Int(3),
			IndicesMemoryIndexBufferSizePercentage:           pulumi.Int(10),
			IndicesMemoryMinIndexBufferSizeMb:                pulumi.Int(48),
			IndicesMemoryMaxIndexBufferSizeMb:                pulumi.Int(3),
			IndicesQueriesCacheSizePercentage:                pulumi.Int(10),
			IndicesRecoveryMaxMbPerSec:                       pulumi.Int(40),
			IndicesRecoveryMaxConcurrentFileChunks:           pulumi.Int(2),
			ActionAutoCreateIndexEnabled:                     pulumi.Bool(true),
			ActionDestructiveRequiresName:                    pulumi.Bool(false),
			EnableSecurityAudit:                              pulumi.Bool(false),
			ThreadPoolSearchSize:                             pulumi.Int(1),
			ThreadPoolSearchThrottledSize:                    pulumi.Int(1),
			ThreadPoolSearchThrottledQueueSize:               pulumi.Int(10),
			ThreadPoolSearchQueueSize:                        pulumi.Int(10),
			ThreadPoolGetSize:                                pulumi.Int(1),
			ThreadPoolGetQueueSize:                           pulumi.Int(10),
			ThreadPoolAnalyzeSize:                            pulumi.Int(1),
			ThreadPoolAnalyzeQueueSize:                       pulumi.Int(10),
			ThreadPoolWriteSize:                              pulumi.Int(1),
			ThreadPoolWriteQueueSize:                         pulumi.Int(10),
			ThreadPoolForceMergeSize:                         pulumi.Int(1),
			OverrideMainResponseVersion:                      pulumi.Bool(false),
			ScriptMaxCompilationsRate:                        pulumi.String("use-context"),
			ClusterMaxShardsPerNode:                          pulumi.Int(100),
			ClusterRoutingAllocationNodeConcurrentRecoveries: pulumi.Int(2),
			PluginsAlertingFilterByBackendRolesEnabled:       pulumi.Bool(false),
			ReindexRemoteWhitelists: pulumi.StringArray{
				pulumi.String("cloud.digitalocean.com:8080"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;
return await Deployment.RunAsync(() => 
{
    var exampleDatabaseCluster = new DigitalOcean.DatabaseCluster("example", new()
    {
        Name = "example-opensearch-cluster",
        Engine = "opensearch",
        Version = "2",
        Size = DigitalOcean.DatabaseSlug.DB_1VPCU2GB,
        Region = DigitalOcean.Region.NYC3,
        NodeCount = 1,
    });
    var example = new DigitalOcean.DatabaseOpensearchConfig("example", new()
    {
        ClusterId = exampleDatabaseCluster.Id,
        IsmEnabled = true,
        IsmHistoryEnabled = true,
        IsmHistoryMaxAgeHours = 24,
        IsmHistoryMaxDocs = 2500000,
        IsmHistoryRolloverCheckPeriodHours = 8,
        IsmHistoryRolloverRetentionPeriodDays = 30,
        HttpMaxContentLengthBytes = 100000000,
        HttpMaxHeaderSizeBytes = 8192,
        HttpMaxInitialLineLengthBytes = 4096,
        IndicesQueryBoolMaxClauseCount = 1024,
        SearchMaxBuckets = 10000,
        IndicesFielddataCacheSizePercentage = 3,
        IndicesMemoryIndexBufferSizePercentage = 10,
        IndicesMemoryMinIndexBufferSizeMb = 48,
        IndicesMemoryMaxIndexBufferSizeMb = 3,
        IndicesQueriesCacheSizePercentage = 10,
        IndicesRecoveryMaxMbPerSec = 40,
        IndicesRecoveryMaxConcurrentFileChunks = 2,
        ActionAutoCreateIndexEnabled = true,
        ActionDestructiveRequiresName = false,
        EnableSecurityAudit = false,
        ThreadPoolSearchSize = 1,
        ThreadPoolSearchThrottledSize = 1,
        ThreadPoolSearchThrottledQueueSize = 10,
        ThreadPoolSearchQueueSize = 10,
        ThreadPoolGetSize = 1,
        ThreadPoolGetQueueSize = 10,
        ThreadPoolAnalyzeSize = 1,
        ThreadPoolAnalyzeQueueSize = 10,
        ThreadPoolWriteSize = 1,
        ThreadPoolWriteQueueSize = 10,
        ThreadPoolForceMergeSize = 1,
        OverrideMainResponseVersion = false,
        ScriptMaxCompilationsRate = "use-context",
        ClusterMaxShardsPerNode = 100,
        ClusterRoutingAllocationNodeConcurrentRecoveries = 2,
        PluginsAlertingFilterByBackendRolesEnabled = false,
        ReindexRemoteWhitelists = new[]
        {
            "cloud.digitalocean.com:8080",
        },
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.DatabaseCluster;
import com.pulumi.digitalocean.DatabaseClusterArgs;
import com.pulumi.digitalocean.DatabaseOpensearchConfig;
import com.pulumi.digitalocean.DatabaseOpensearchConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var exampleDatabaseCluster = new DatabaseCluster("exampleDatabaseCluster", DatabaseClusterArgs.builder()
            .name("example-opensearch-cluster")
            .engine("opensearch")
            .version("2")
            .size("db-s-1vcpu-2gb")
            .region("nyc3")
            .nodeCount(1)
            .build());
        var example = new DatabaseOpensearchConfig("example", DatabaseOpensearchConfigArgs.builder()
            .clusterId(exampleDatabaseCluster.id())
            .ismEnabled(true)
            .ismHistoryEnabled(true)
            .ismHistoryMaxAgeHours(24)
            .ismHistoryMaxDocs(2500000)
            .ismHistoryRolloverCheckPeriodHours(8)
            .ismHistoryRolloverRetentionPeriodDays(30)
            .httpMaxContentLengthBytes(100000000)
            .httpMaxHeaderSizeBytes(8192)
            .httpMaxInitialLineLengthBytes(4096)
            .indicesQueryBoolMaxClauseCount(1024)
            .searchMaxBuckets(10000)
            .indicesFielddataCacheSizePercentage(3)
            .indicesMemoryIndexBufferSizePercentage(10)
            .indicesMemoryMinIndexBufferSizeMb(48)
            .indicesMemoryMaxIndexBufferSizeMb(3)
            .indicesQueriesCacheSizePercentage(10)
            .indicesRecoveryMaxMbPerSec(40)
            .indicesRecoveryMaxConcurrentFileChunks(2)
            .actionAutoCreateIndexEnabled(true)
            .actionDestructiveRequiresName(false)
            .enableSecurityAudit(false)
            .threadPoolSearchSize(1)
            .threadPoolSearchThrottledSize(1)
            .threadPoolSearchThrottledQueueSize(10)
            .threadPoolSearchQueueSize(10)
            .threadPoolGetSize(1)
            .threadPoolGetQueueSize(10)
            .threadPoolAnalyzeSize(1)
            .threadPoolAnalyzeQueueSize(10)
            .threadPoolWriteSize(1)
            .threadPoolWriteQueueSize(10)
            .threadPoolForceMergeSize(1)
            .overrideMainResponseVersion(false)
            .scriptMaxCompilationsRate("use-context")
            .clusterMaxShardsPerNode(100)
            .clusterRoutingAllocationNodeConcurrentRecoveries(2)
            .pluginsAlertingFilterByBackendRolesEnabled(false)
            .reindexRemoteWhitelists("cloud.digitalocean.com:8080")
            .build());
    }
}
resources:
  example:
    type: digitalocean:DatabaseOpensearchConfig
    properties:
      clusterId: ${exampleDatabaseCluster.id}
      ismEnabled: true
      ismHistoryEnabled: true
      ismHistoryMaxAgeHours: 24
      ismHistoryMaxDocs: 2.5e+06
      ismHistoryRolloverCheckPeriodHours: 8
      ismHistoryRolloverRetentionPeriodDays: 30
      httpMaxContentLengthBytes: 1e+08
      httpMaxHeaderSizeBytes: 8192
      httpMaxInitialLineLengthBytes: 4096
      indicesQueryBoolMaxClauseCount: 1024
      searchMaxBuckets: 10000
      indicesFielddataCacheSizePercentage: 3
      indicesMemoryIndexBufferSizePercentage: 10
      indicesMemoryMinIndexBufferSizeMb: 48
      indicesMemoryMaxIndexBufferSizeMb: 3
      indicesQueriesCacheSizePercentage: 10
      indicesRecoveryMaxMbPerSec: 40
      indicesRecoveryMaxConcurrentFileChunks: 2
      actionAutoCreateIndexEnabled: true
      actionDestructiveRequiresName: false
      enableSecurityAudit: false
      threadPoolSearchSize: 1
      threadPoolSearchThrottledSize: 1
      threadPoolSearchThrottledQueueSize: 10
      threadPoolSearchQueueSize: 10
      threadPoolGetSize: 1
      threadPoolGetQueueSize: 10
      threadPoolAnalyzeSize: 1
      threadPoolAnalyzeQueueSize: 10
      threadPoolWriteSize: 1
      threadPoolWriteQueueSize: 10
      threadPoolForceMergeSize: 1
      overrideMainResponseVersion: false
      scriptMaxCompilationsRate: use-context
      clusterMaxShardsPerNode: 100
      clusterRoutingAllocationNodeConcurrentRecoveries: 2
      pluginsAlertingFilterByBackendRolesEnabled: false
      reindexRemoteWhitelists:
        - cloud.digitalocean.com:8080
  exampleDatabaseCluster:
    type: digitalocean:DatabaseCluster
    name: example
    properties:
      name: example-opensearch-cluster
      engine: opensearch
      version: '2'
      size: db-s-1vcpu-2gb
      region: nyc3
      nodeCount: 1
Create DatabaseOpensearchConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DatabaseOpensearchConfig(name: string, args: DatabaseOpensearchConfigArgs, opts?: CustomResourceOptions);@overload
def DatabaseOpensearchConfig(resource_name: str,
                             args: DatabaseOpensearchConfigArgs,
                             opts: Optional[ResourceOptions] = None)
@overload
def DatabaseOpensearchConfig(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             cluster_id: Optional[str] = None,
                             ism_history_enabled: Optional[bool] = None,
                             thread_pool_write_queue_size: Optional[int] = None,
                             cluster_max_shards_per_node: Optional[int] = None,
                             cluster_routing_allocation_node_concurrent_recoveries: Optional[int] = None,
                             enable_security_audit: Optional[bool] = None,
                             http_max_content_length_bytes: Optional[int] = None,
                             http_max_header_size_bytes: Optional[int] = None,
                             http_max_initial_line_length_bytes: Optional[int] = None,
                             ism_history_max_age_hours: Optional[int] = None,
                             indices_memory_index_buffer_size_percentage: Optional[int] = None,
                             indices_memory_max_index_buffer_size_mb: Optional[int] = None,
                             indices_memory_min_index_buffer_size_mb: Optional[int] = None,
                             indices_queries_cache_size_percentage: Optional[int] = None,
                             indices_query_bool_max_clause_count: Optional[int] = None,
                             indices_recovery_max_concurrent_file_chunks: Optional[int] = None,
                             indices_recovery_max_mb_per_sec: Optional[int] = None,
                             ism_enabled: Optional[bool] = None,
                             action_auto_create_index_enabled: Optional[bool] = None,
                             indices_fielddata_cache_size_percentage: Optional[int] = None,
                             action_destructive_requires_name: Optional[bool] = None,
                             script_max_compilations_rate: Optional[str] = None,
                             ism_history_rollover_retention_period_days: Optional[int] = None,
                             override_main_response_version: Optional[bool] = None,
                             plugins_alerting_filter_by_backend_roles_enabled: Optional[bool] = None,
                             reindex_remote_whitelists: Optional[Sequence[str]] = None,
                             ism_history_rollover_check_period_hours: Optional[int] = None,
                             search_max_buckets: Optional[int] = None,
                             thread_pool_analyze_queue_size: Optional[int] = None,
                             thread_pool_analyze_size: Optional[int] = None,
                             thread_pool_force_merge_size: Optional[int] = None,
                             thread_pool_get_queue_size: Optional[int] = None,
                             thread_pool_get_size: Optional[int] = None,
                             thread_pool_search_queue_size: Optional[int] = None,
                             thread_pool_search_size: Optional[int] = None,
                             thread_pool_search_throttled_queue_size: Optional[int] = None,
                             thread_pool_search_throttled_size: Optional[int] = None,
                             ism_history_max_docs: Optional[int] = None,
                             thread_pool_write_size: Optional[int] = None)func NewDatabaseOpensearchConfig(ctx *Context, name string, args DatabaseOpensearchConfigArgs, opts ...ResourceOption) (*DatabaseOpensearchConfig, error)public DatabaseOpensearchConfig(string name, DatabaseOpensearchConfigArgs args, CustomResourceOptions? opts = null)
public DatabaseOpensearchConfig(String name, DatabaseOpensearchConfigArgs args)
public DatabaseOpensearchConfig(String name, DatabaseOpensearchConfigArgs args, CustomResourceOptions options)
type: digitalocean:DatabaseOpensearchConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DatabaseOpensearchConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DatabaseOpensearchConfigArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DatabaseOpensearchConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DatabaseOpensearchConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DatabaseOpensearchConfigArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var databaseOpensearchConfigResource = new DigitalOcean.DatabaseOpensearchConfig("databaseOpensearchConfigResource", new()
{
    ClusterId = "string",
    IsmHistoryEnabled = false,
    ThreadPoolWriteQueueSize = 0,
    ClusterMaxShardsPerNode = 0,
    ClusterRoutingAllocationNodeConcurrentRecoveries = 0,
    EnableSecurityAudit = false,
    HttpMaxContentLengthBytes = 0,
    HttpMaxHeaderSizeBytes = 0,
    HttpMaxInitialLineLengthBytes = 0,
    IsmHistoryMaxAgeHours = 0,
    IndicesMemoryIndexBufferSizePercentage = 0,
    IndicesMemoryMaxIndexBufferSizeMb = 0,
    IndicesMemoryMinIndexBufferSizeMb = 0,
    IndicesQueriesCacheSizePercentage = 0,
    IndicesQueryBoolMaxClauseCount = 0,
    IndicesRecoveryMaxConcurrentFileChunks = 0,
    IndicesRecoveryMaxMbPerSec = 0,
    IsmEnabled = false,
    ActionAutoCreateIndexEnabled = false,
    IndicesFielddataCacheSizePercentage = 0,
    ActionDestructiveRequiresName = false,
    ScriptMaxCompilationsRate = "string",
    IsmHistoryRolloverRetentionPeriodDays = 0,
    OverrideMainResponseVersion = false,
    PluginsAlertingFilterByBackendRolesEnabled = false,
    ReindexRemoteWhitelists = new[]
    {
        "string",
    },
    IsmHistoryRolloverCheckPeriodHours = 0,
    SearchMaxBuckets = 0,
    ThreadPoolAnalyzeQueueSize = 0,
    ThreadPoolAnalyzeSize = 0,
    ThreadPoolForceMergeSize = 0,
    ThreadPoolGetQueueSize = 0,
    ThreadPoolGetSize = 0,
    ThreadPoolSearchQueueSize = 0,
    ThreadPoolSearchSize = 0,
    ThreadPoolSearchThrottledQueueSize = 0,
    ThreadPoolSearchThrottledSize = 0,
    IsmHistoryMaxDocs = 0,
    ThreadPoolWriteSize = 0,
});
example, err := digitalocean.NewDatabaseOpensearchConfig(ctx, "databaseOpensearchConfigResource", &digitalocean.DatabaseOpensearchConfigArgs{
	ClusterId:                pulumi.String("string"),
	IsmHistoryEnabled:        pulumi.Bool(false),
	ThreadPoolWriteQueueSize: pulumi.Int(0),
	ClusterMaxShardsPerNode:  pulumi.Int(0),
	ClusterRoutingAllocationNodeConcurrentRecoveries: pulumi.Int(0),
	EnableSecurityAudit:                        pulumi.Bool(false),
	HttpMaxContentLengthBytes:                  pulumi.Int(0),
	HttpMaxHeaderSizeBytes:                     pulumi.Int(0),
	HttpMaxInitialLineLengthBytes:              pulumi.Int(0),
	IsmHistoryMaxAgeHours:                      pulumi.Int(0),
	IndicesMemoryIndexBufferSizePercentage:     pulumi.Int(0),
	IndicesMemoryMaxIndexBufferSizeMb:          pulumi.Int(0),
	IndicesMemoryMinIndexBufferSizeMb:          pulumi.Int(0),
	IndicesQueriesCacheSizePercentage:          pulumi.Int(0),
	IndicesQueryBoolMaxClauseCount:             pulumi.Int(0),
	IndicesRecoveryMaxConcurrentFileChunks:     pulumi.Int(0),
	IndicesRecoveryMaxMbPerSec:                 pulumi.Int(0),
	IsmEnabled:                                 pulumi.Bool(false),
	ActionAutoCreateIndexEnabled:               pulumi.Bool(false),
	IndicesFielddataCacheSizePercentage:        pulumi.Int(0),
	ActionDestructiveRequiresName:              pulumi.Bool(false),
	ScriptMaxCompilationsRate:                  pulumi.String("string"),
	IsmHistoryRolloverRetentionPeriodDays:      pulumi.Int(0),
	OverrideMainResponseVersion:                pulumi.Bool(false),
	PluginsAlertingFilterByBackendRolesEnabled: pulumi.Bool(false),
	ReindexRemoteWhitelists: pulumi.StringArray{
		pulumi.String("string"),
	},
	IsmHistoryRolloverCheckPeriodHours: pulumi.Int(0),
	SearchMaxBuckets:                   pulumi.Int(0),
	ThreadPoolAnalyzeQueueSize:         pulumi.Int(0),
	ThreadPoolAnalyzeSize:              pulumi.Int(0),
	ThreadPoolForceMergeSize:           pulumi.Int(0),
	ThreadPoolGetQueueSize:             pulumi.Int(0),
	ThreadPoolGetSize:                  pulumi.Int(0),
	ThreadPoolSearchQueueSize:          pulumi.Int(0),
	ThreadPoolSearchSize:               pulumi.Int(0),
	ThreadPoolSearchThrottledQueueSize: pulumi.Int(0),
	ThreadPoolSearchThrottledSize:      pulumi.Int(0),
	IsmHistoryMaxDocs:                  pulumi.Int(0),
	ThreadPoolWriteSize:                pulumi.Int(0),
})
var databaseOpensearchConfigResource = new DatabaseOpensearchConfig("databaseOpensearchConfigResource", DatabaseOpensearchConfigArgs.builder()
    .clusterId("string")
    .ismHistoryEnabled(false)
    .threadPoolWriteQueueSize(0)
    .clusterMaxShardsPerNode(0)
    .clusterRoutingAllocationNodeConcurrentRecoveries(0)
    .enableSecurityAudit(false)
    .httpMaxContentLengthBytes(0)
    .httpMaxHeaderSizeBytes(0)
    .httpMaxInitialLineLengthBytes(0)
    .ismHistoryMaxAgeHours(0)
    .indicesMemoryIndexBufferSizePercentage(0)
    .indicesMemoryMaxIndexBufferSizeMb(0)
    .indicesMemoryMinIndexBufferSizeMb(0)
    .indicesQueriesCacheSizePercentage(0)
    .indicesQueryBoolMaxClauseCount(0)
    .indicesRecoveryMaxConcurrentFileChunks(0)
    .indicesRecoveryMaxMbPerSec(0)
    .ismEnabled(false)
    .actionAutoCreateIndexEnabled(false)
    .indicesFielddataCacheSizePercentage(0)
    .actionDestructiveRequiresName(false)
    .scriptMaxCompilationsRate("string")
    .ismHistoryRolloverRetentionPeriodDays(0)
    .overrideMainResponseVersion(false)
    .pluginsAlertingFilterByBackendRolesEnabled(false)
    .reindexRemoteWhitelists("string")
    .ismHistoryRolloverCheckPeriodHours(0)
    .searchMaxBuckets(0)
    .threadPoolAnalyzeQueueSize(0)
    .threadPoolAnalyzeSize(0)
    .threadPoolForceMergeSize(0)
    .threadPoolGetQueueSize(0)
    .threadPoolGetSize(0)
    .threadPoolSearchQueueSize(0)
    .threadPoolSearchSize(0)
    .threadPoolSearchThrottledQueueSize(0)
    .threadPoolSearchThrottledSize(0)
    .ismHistoryMaxDocs(0)
    .threadPoolWriteSize(0)
    .build());
database_opensearch_config_resource = digitalocean.DatabaseOpensearchConfig("databaseOpensearchConfigResource",
    cluster_id="string",
    ism_history_enabled=False,
    thread_pool_write_queue_size=0,
    cluster_max_shards_per_node=0,
    cluster_routing_allocation_node_concurrent_recoveries=0,
    enable_security_audit=False,
    http_max_content_length_bytes=0,
    http_max_header_size_bytes=0,
    http_max_initial_line_length_bytes=0,
    ism_history_max_age_hours=0,
    indices_memory_index_buffer_size_percentage=0,
    indices_memory_max_index_buffer_size_mb=0,
    indices_memory_min_index_buffer_size_mb=0,
    indices_queries_cache_size_percentage=0,
    indices_query_bool_max_clause_count=0,
    indices_recovery_max_concurrent_file_chunks=0,
    indices_recovery_max_mb_per_sec=0,
    ism_enabled=False,
    action_auto_create_index_enabled=False,
    indices_fielddata_cache_size_percentage=0,
    action_destructive_requires_name=False,
    script_max_compilations_rate="string",
    ism_history_rollover_retention_period_days=0,
    override_main_response_version=False,
    plugins_alerting_filter_by_backend_roles_enabled=False,
    reindex_remote_whitelists=["string"],
    ism_history_rollover_check_period_hours=0,
    search_max_buckets=0,
    thread_pool_analyze_queue_size=0,
    thread_pool_analyze_size=0,
    thread_pool_force_merge_size=0,
    thread_pool_get_queue_size=0,
    thread_pool_get_size=0,
    thread_pool_search_queue_size=0,
    thread_pool_search_size=0,
    thread_pool_search_throttled_queue_size=0,
    thread_pool_search_throttled_size=0,
    ism_history_max_docs=0,
    thread_pool_write_size=0)
const databaseOpensearchConfigResource = new digitalocean.DatabaseOpensearchConfig("databaseOpensearchConfigResource", {
    clusterId: "string",
    ismHistoryEnabled: false,
    threadPoolWriteQueueSize: 0,
    clusterMaxShardsPerNode: 0,
    clusterRoutingAllocationNodeConcurrentRecoveries: 0,
    enableSecurityAudit: false,
    httpMaxContentLengthBytes: 0,
    httpMaxHeaderSizeBytes: 0,
    httpMaxInitialLineLengthBytes: 0,
    ismHistoryMaxAgeHours: 0,
    indicesMemoryIndexBufferSizePercentage: 0,
    indicesMemoryMaxIndexBufferSizeMb: 0,
    indicesMemoryMinIndexBufferSizeMb: 0,
    indicesQueriesCacheSizePercentage: 0,
    indicesQueryBoolMaxClauseCount: 0,
    indicesRecoveryMaxConcurrentFileChunks: 0,
    indicesRecoveryMaxMbPerSec: 0,
    ismEnabled: false,
    actionAutoCreateIndexEnabled: false,
    indicesFielddataCacheSizePercentage: 0,
    actionDestructiveRequiresName: false,
    scriptMaxCompilationsRate: "string",
    ismHistoryRolloverRetentionPeriodDays: 0,
    overrideMainResponseVersion: false,
    pluginsAlertingFilterByBackendRolesEnabled: false,
    reindexRemoteWhitelists: ["string"],
    ismHistoryRolloverCheckPeriodHours: 0,
    searchMaxBuckets: 0,
    threadPoolAnalyzeQueueSize: 0,
    threadPoolAnalyzeSize: 0,
    threadPoolForceMergeSize: 0,
    threadPoolGetQueueSize: 0,
    threadPoolGetSize: 0,
    threadPoolSearchQueueSize: 0,
    threadPoolSearchSize: 0,
    threadPoolSearchThrottledQueueSize: 0,
    threadPoolSearchThrottledSize: 0,
    ismHistoryMaxDocs: 0,
    threadPoolWriteSize: 0,
});
type: digitalocean:DatabaseOpensearchConfig
properties:
    actionAutoCreateIndexEnabled: false
    actionDestructiveRequiresName: false
    clusterId: string
    clusterMaxShardsPerNode: 0
    clusterRoutingAllocationNodeConcurrentRecoveries: 0
    enableSecurityAudit: false
    httpMaxContentLengthBytes: 0
    httpMaxHeaderSizeBytes: 0
    httpMaxInitialLineLengthBytes: 0
    indicesFielddataCacheSizePercentage: 0
    indicesMemoryIndexBufferSizePercentage: 0
    indicesMemoryMaxIndexBufferSizeMb: 0
    indicesMemoryMinIndexBufferSizeMb: 0
    indicesQueriesCacheSizePercentage: 0
    indicesQueryBoolMaxClauseCount: 0
    indicesRecoveryMaxConcurrentFileChunks: 0
    indicesRecoveryMaxMbPerSec: 0
    ismEnabled: false
    ismHistoryEnabled: false
    ismHistoryMaxAgeHours: 0
    ismHistoryMaxDocs: 0
    ismHistoryRolloverCheckPeriodHours: 0
    ismHistoryRolloverRetentionPeriodDays: 0
    overrideMainResponseVersion: false
    pluginsAlertingFilterByBackendRolesEnabled: false
    reindexRemoteWhitelists:
        - string
    scriptMaxCompilationsRate: string
    searchMaxBuckets: 0
    threadPoolAnalyzeQueueSize: 0
    threadPoolAnalyzeSize: 0
    threadPoolForceMergeSize: 0
    threadPoolGetQueueSize: 0
    threadPoolGetSize: 0
    threadPoolSearchQueueSize: 0
    threadPoolSearchSize: 0
    threadPoolSearchThrottledQueueSize: 0
    threadPoolSearchThrottledSize: 0
    threadPoolWriteQueueSize: 0
    threadPoolWriteSize: 0
DatabaseOpensearchConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DatabaseOpensearchConfig resource accepts the following input properties:
- ClusterId string
- The ID of the target Opensearch cluster.
- ActionAuto boolCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- ActionDestructive boolRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- ClusterMax intShards Per Node 
- Maximum number of shards allowed per data node.
- ClusterRouting intAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- EnableSecurity boolAudit 
- Specifies whether to allow security audit logging. Default: false
- HttpMax intContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- HttpMax intHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- HttpMax intInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- IndicesFielddata intCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- IndicesMemory intIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- IndicesMemory intMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- IndicesMemory intMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- IndicesQueries intCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- IndicesQuery intBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- IndicesRecovery intMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- IndicesRecovery intMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- IsmEnabled bool
- Specifies whether ISM is enabled or not. Default: true
- IsmHistory boolEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- IsmHistory intMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- IsmHistory intMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- IsmHistory intRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- IsmHistory intRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- OverrideMain boolResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- PluginsAlerting boolFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- ReindexRemote List<string>Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- ScriptMax stringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- SearchMax intBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- ThreadPool intAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- ThreadPool intAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intGet Queue Size 
- Size of queue for operations in the get thread pool.
- ThreadPool intGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Queue Size 
- Size of queue for operations in the search thread pool.
- ThreadPool intSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- ThreadPool intSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intWrite Queue Size 
- Size of queue for operations in the write thread pool.
- ThreadPool intWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ClusterId string
- The ID of the target Opensearch cluster.
- ActionAuto boolCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- ActionDestructive boolRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- ClusterMax intShards Per Node 
- Maximum number of shards allowed per data node.
- ClusterRouting intAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- EnableSecurity boolAudit 
- Specifies whether to allow security audit logging. Default: false
- HttpMax intContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- HttpMax intHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- HttpMax intInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- IndicesFielddata intCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- IndicesMemory intIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- IndicesMemory intMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- IndicesMemory intMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- IndicesQueries intCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- IndicesQuery intBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- IndicesRecovery intMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- IndicesRecovery intMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- IsmEnabled bool
- Specifies whether ISM is enabled or not. Default: true
- IsmHistory boolEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- IsmHistory intMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- IsmHistory intMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- IsmHistory intRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- IsmHistory intRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- OverrideMain boolResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- PluginsAlerting boolFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- ReindexRemote []stringWhitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- ScriptMax stringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- SearchMax intBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- ThreadPool intAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- ThreadPool intAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intGet Queue Size 
- Size of queue for operations in the get thread pool.
- ThreadPool intGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Queue Size 
- Size of queue for operations in the search thread pool.
- ThreadPool intSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- ThreadPool intSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intWrite Queue Size 
- Size of queue for operations in the write thread pool.
- ThreadPool intWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- clusterId String
- The ID of the target Opensearch cluster.
- actionAuto BooleanCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- actionDestructive BooleanRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- clusterMax IntegerShards Per Node 
- Maximum number of shards allowed per data node.
- clusterRouting IntegerAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enableSecurity BooleanAudit 
- Specifies whether to allow security audit logging. Default: false
- httpMax IntegerContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- httpMax IntegerHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- httpMax IntegerInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indicesFielddata IntegerCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indicesMemory IntegerIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indicesMemory IntegerMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indicesMemory IntegerMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indicesQueries IntegerCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indicesQuery IntegerBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indicesRecovery IntegerMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indicesRecovery IntegerMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ismEnabled Boolean
- Specifies whether ISM is enabled or not. Default: true
- ismHistory BooleanEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ismHistory IntegerMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ismHistory IntegerMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ismHistory IntegerRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ismHistory IntegerRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- overrideMain BooleanResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- pluginsAlerting BooleanFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindexRemote List<String>Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- scriptMax StringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- searchMax IntegerBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- threadPool IntegerAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- threadPool IntegerAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerGet Queue Size 
- Size of queue for operations in the get thread pool.
- threadPool IntegerGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerSearch Queue Size 
- Size of queue for operations in the search thread pool.
- threadPool IntegerSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- threadPool IntegerSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerWrite Queue Size 
- Size of queue for operations in the write thread pool.
- threadPool IntegerWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- clusterId string
- The ID of the target Opensearch cluster.
- actionAuto booleanCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- actionDestructive booleanRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- clusterMax numberShards Per Node 
- Maximum number of shards allowed per data node.
- clusterRouting numberAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enableSecurity booleanAudit 
- Specifies whether to allow security audit logging. Default: false
- httpMax numberContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- httpMax numberHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- httpMax numberInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indicesFielddata numberCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indicesMemory numberIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indicesMemory numberMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indicesMemory numberMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indicesQueries numberCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indicesQuery numberBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indicesRecovery numberMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indicesRecovery numberMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ismEnabled boolean
- Specifies whether ISM is enabled or not. Default: true
- ismHistory booleanEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ismHistory numberMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ismHistory numberMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ismHistory numberRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ismHistory numberRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- overrideMain booleanResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- pluginsAlerting booleanFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindexRemote string[]Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- scriptMax stringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- searchMax numberBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- threadPool numberAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- threadPool numberAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberGet Queue Size 
- Size of queue for operations in the get thread pool.
- threadPool numberGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberSearch Queue Size 
- Size of queue for operations in the search thread pool.
- threadPool numberSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- threadPool numberSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberWrite Queue Size 
- Size of queue for operations in the write thread pool.
- threadPool numberWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- cluster_id str
- The ID of the target Opensearch cluster.
- action_auto_ boolcreate_ index_ enabled 
- Specifies whether ISM is enabled or not. Default: true
- action_destructive_ boolrequires_ name 
- Specifies whether to require explicit index names when deleting indices.
- cluster_max_ intshards_ per_ node 
- Maximum number of shards allowed per data node.
- cluster_routing_ intallocation_ node_ concurrent_ recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enable_security_ boolaudit 
- Specifies whether to allow security audit logging. Default: false
- http_max_ intcontent_ length_ bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- http_max_ intheader_ size_ bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- http_max_ intinitial_ line_ length_ bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indices_fielddata_ intcache_ size_ percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indices_memory_ intindex_ buffer_ size_ percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indices_memory_ intmax_ index_ buffer_ size_ mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indices_memory_ intmin_ index_ buffer_ size_ mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indices_queries_ intcache_ size_ percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indices_query_ intbool_ max_ clause_ count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indices_recovery_ intmax_ concurrent_ file_ chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indices_recovery_ intmax_ mb_ per_ sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ism_enabled bool
- Specifies whether ISM is enabled or not. Default: true
- ism_history_ boolenabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ism_history_ intmax_ age_ hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ism_history_ intmax_ docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ism_history_ introllover_ check_ period_ hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ism_history_ introllover_ retention_ period_ days 
- Length of time long audit history indices are kept, in days. Default: 30
- override_main_ boolresponse_ version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- plugins_alerting_ boolfilter_ by_ backend_ roles_ enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindex_remote_ Sequence[str]whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- script_max_ strcompilations_ rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- search_max_ intbuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- thread_pool_ intanalyze_ queue_ size 
- Size of queue for operations in the analyze thread pool.
- thread_pool_ intanalyze_ size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intforce_ merge_ size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intget_ queue_ size 
- Size of queue for operations in the get thread pool.
- thread_pool_ intget_ size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intsearch_ queue_ size 
- Size of queue for operations in the search thread pool.
- thread_pool_ intsearch_ size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intsearch_ throttled_ queue_ size 
- Size of queue for operations in the search throttled thread pool.
- thread_pool_ intsearch_ throttled_ size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intwrite_ queue_ size 
- Size of queue for operations in the write thread pool.
- thread_pool_ intwrite_ size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- clusterId String
- The ID of the target Opensearch cluster.
- actionAuto BooleanCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- actionDestructive BooleanRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- clusterMax NumberShards Per Node 
- Maximum number of shards allowed per data node.
- clusterRouting NumberAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enableSecurity BooleanAudit 
- Specifies whether to allow security audit logging. Default: false
- httpMax NumberContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- httpMax NumberHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- httpMax NumberInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indicesFielddata NumberCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indicesMemory NumberIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indicesMemory NumberMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indicesMemory NumberMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indicesQueries NumberCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indicesQuery NumberBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indicesRecovery NumberMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indicesRecovery NumberMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ismEnabled Boolean
- Specifies whether ISM is enabled or not. Default: true
- ismHistory BooleanEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ismHistory NumberMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ismHistory NumberMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ismHistory NumberRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ismHistory NumberRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- overrideMain BooleanResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- pluginsAlerting BooleanFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindexRemote List<String>Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- scriptMax StringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- searchMax NumberBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- threadPool NumberAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- threadPool NumberAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberGet Queue Size 
- Size of queue for operations in the get thread pool.
- threadPool NumberGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberSearch Queue Size 
- Size of queue for operations in the search thread pool.
- threadPool NumberSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- threadPool NumberSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberWrite Queue Size 
- Size of queue for operations in the write thread pool.
- threadPool NumberWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
Outputs
All input properties are implicitly available as output properties. Additionally, the DatabaseOpensearchConfig resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing DatabaseOpensearchConfig Resource
Get an existing DatabaseOpensearchConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: DatabaseOpensearchConfigState, opts?: CustomResourceOptions): DatabaseOpensearchConfig@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_auto_create_index_enabled: Optional[bool] = None,
        action_destructive_requires_name: Optional[bool] = None,
        cluster_id: Optional[str] = None,
        cluster_max_shards_per_node: Optional[int] = None,
        cluster_routing_allocation_node_concurrent_recoveries: Optional[int] = None,
        enable_security_audit: Optional[bool] = None,
        http_max_content_length_bytes: Optional[int] = None,
        http_max_header_size_bytes: Optional[int] = None,
        http_max_initial_line_length_bytes: Optional[int] = None,
        indices_fielddata_cache_size_percentage: Optional[int] = None,
        indices_memory_index_buffer_size_percentage: Optional[int] = None,
        indices_memory_max_index_buffer_size_mb: Optional[int] = None,
        indices_memory_min_index_buffer_size_mb: Optional[int] = None,
        indices_queries_cache_size_percentage: Optional[int] = None,
        indices_query_bool_max_clause_count: Optional[int] = None,
        indices_recovery_max_concurrent_file_chunks: Optional[int] = None,
        indices_recovery_max_mb_per_sec: Optional[int] = None,
        ism_enabled: Optional[bool] = None,
        ism_history_enabled: Optional[bool] = None,
        ism_history_max_age_hours: Optional[int] = None,
        ism_history_max_docs: Optional[int] = None,
        ism_history_rollover_check_period_hours: Optional[int] = None,
        ism_history_rollover_retention_period_days: Optional[int] = None,
        override_main_response_version: Optional[bool] = None,
        plugins_alerting_filter_by_backend_roles_enabled: Optional[bool] = None,
        reindex_remote_whitelists: Optional[Sequence[str]] = None,
        script_max_compilations_rate: Optional[str] = None,
        search_max_buckets: Optional[int] = None,
        thread_pool_analyze_queue_size: Optional[int] = None,
        thread_pool_analyze_size: Optional[int] = None,
        thread_pool_force_merge_size: Optional[int] = None,
        thread_pool_get_queue_size: Optional[int] = None,
        thread_pool_get_size: Optional[int] = None,
        thread_pool_search_queue_size: Optional[int] = None,
        thread_pool_search_size: Optional[int] = None,
        thread_pool_search_throttled_queue_size: Optional[int] = None,
        thread_pool_search_throttled_size: Optional[int] = None,
        thread_pool_write_queue_size: Optional[int] = None,
        thread_pool_write_size: Optional[int] = None) -> DatabaseOpensearchConfigfunc GetDatabaseOpensearchConfig(ctx *Context, name string, id IDInput, state *DatabaseOpensearchConfigState, opts ...ResourceOption) (*DatabaseOpensearchConfig, error)public static DatabaseOpensearchConfig Get(string name, Input<string> id, DatabaseOpensearchConfigState? state, CustomResourceOptions? opts = null)public static DatabaseOpensearchConfig get(String name, Output<String> id, DatabaseOpensearchConfigState state, CustomResourceOptions options)Resource lookup is not supported in YAML- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- ActionAuto boolCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- ActionDestructive boolRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- ClusterId string
- The ID of the target Opensearch cluster.
- ClusterMax intShards Per Node 
- Maximum number of shards allowed per data node.
- ClusterRouting intAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- EnableSecurity boolAudit 
- Specifies whether to allow security audit logging. Default: false
- HttpMax intContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- HttpMax intHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- HttpMax intInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- IndicesFielddata intCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- IndicesMemory intIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- IndicesMemory intMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- IndicesMemory intMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- IndicesQueries intCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- IndicesQuery intBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- IndicesRecovery intMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- IndicesRecovery intMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- IsmEnabled bool
- Specifies whether ISM is enabled or not. Default: true
- IsmHistory boolEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- IsmHistory intMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- IsmHistory intMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- IsmHistory intRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- IsmHistory intRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- OverrideMain boolResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- PluginsAlerting boolFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- ReindexRemote List<string>Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- ScriptMax stringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- SearchMax intBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- ThreadPool intAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- ThreadPool intAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intGet Queue Size 
- Size of queue for operations in the get thread pool.
- ThreadPool intGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Queue Size 
- Size of queue for operations in the search thread pool.
- ThreadPool intSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- ThreadPool intSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intWrite Queue Size 
- Size of queue for operations in the write thread pool.
- ThreadPool intWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ActionAuto boolCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- ActionDestructive boolRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- ClusterId string
- The ID of the target Opensearch cluster.
- ClusterMax intShards Per Node 
- Maximum number of shards allowed per data node.
- ClusterRouting intAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- EnableSecurity boolAudit 
- Specifies whether to allow security audit logging. Default: false
- HttpMax intContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- HttpMax intHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- HttpMax intInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- IndicesFielddata intCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- IndicesMemory intIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- IndicesMemory intMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- IndicesMemory intMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- IndicesQueries intCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- IndicesQuery intBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- IndicesRecovery intMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- IndicesRecovery intMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- IsmEnabled bool
- Specifies whether ISM is enabled or not. Default: true
- IsmHistory boolEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- IsmHistory intMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- IsmHistory intMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- IsmHistory intRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- IsmHistory intRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- OverrideMain boolResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- PluginsAlerting boolFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- ReindexRemote []stringWhitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- ScriptMax stringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- SearchMax intBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- ThreadPool intAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- ThreadPool intAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intGet Queue Size 
- Size of queue for operations in the get thread pool.
- ThreadPool intGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Queue Size 
- Size of queue for operations in the search thread pool.
- ThreadPool intSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- ThreadPool intSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- ThreadPool intWrite Queue Size 
- Size of queue for operations in the write thread pool.
- ThreadPool intWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- actionAuto BooleanCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- actionDestructive BooleanRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- clusterId String
- The ID of the target Opensearch cluster.
- clusterMax IntegerShards Per Node 
- Maximum number of shards allowed per data node.
- clusterRouting IntegerAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enableSecurity BooleanAudit 
- Specifies whether to allow security audit logging. Default: false
- httpMax IntegerContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- httpMax IntegerHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- httpMax IntegerInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indicesFielddata IntegerCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indicesMemory IntegerIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indicesMemory IntegerMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indicesMemory IntegerMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indicesQueries IntegerCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indicesQuery IntegerBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indicesRecovery IntegerMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indicesRecovery IntegerMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ismEnabled Boolean
- Specifies whether ISM is enabled or not. Default: true
- ismHistory BooleanEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ismHistory IntegerMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ismHistory IntegerMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ismHistory IntegerRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ismHistory IntegerRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- overrideMain BooleanResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- pluginsAlerting BooleanFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindexRemote List<String>Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- scriptMax StringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- searchMax IntegerBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- threadPool IntegerAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- threadPool IntegerAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerGet Queue Size 
- Size of queue for operations in the get thread pool.
- threadPool IntegerGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerSearch Queue Size 
- Size of queue for operations in the search thread pool.
- threadPool IntegerSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- threadPool IntegerSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool IntegerWrite Queue Size 
- Size of queue for operations in the write thread pool.
- threadPool IntegerWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- actionAuto booleanCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- actionDestructive booleanRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- clusterId string
- The ID of the target Opensearch cluster.
- clusterMax numberShards Per Node 
- Maximum number of shards allowed per data node.
- clusterRouting numberAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enableSecurity booleanAudit 
- Specifies whether to allow security audit logging. Default: false
- httpMax numberContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- httpMax numberHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- httpMax numberInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indicesFielddata numberCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indicesMemory numberIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indicesMemory numberMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indicesMemory numberMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indicesQueries numberCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indicesQuery numberBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indicesRecovery numberMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indicesRecovery numberMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ismEnabled boolean
- Specifies whether ISM is enabled or not. Default: true
- ismHistory booleanEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ismHistory numberMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ismHistory numberMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ismHistory numberRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ismHistory numberRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- overrideMain booleanResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- pluginsAlerting booleanFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindexRemote string[]Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- scriptMax stringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- searchMax numberBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- threadPool numberAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- threadPool numberAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberGet Queue Size 
- Size of queue for operations in the get thread pool.
- threadPool numberGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberSearch Queue Size 
- Size of queue for operations in the search thread pool.
- threadPool numberSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- threadPool numberSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool numberWrite Queue Size 
- Size of queue for operations in the write thread pool.
- threadPool numberWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- action_auto_ boolcreate_ index_ enabled 
- Specifies whether ISM is enabled or not. Default: true
- action_destructive_ boolrequires_ name 
- Specifies whether to require explicit index names when deleting indices.
- cluster_id str
- The ID of the target Opensearch cluster.
- cluster_max_ intshards_ per_ node 
- Maximum number of shards allowed per data node.
- cluster_routing_ intallocation_ node_ concurrent_ recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enable_security_ boolaudit 
- Specifies whether to allow security audit logging. Default: false
- http_max_ intcontent_ length_ bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- http_max_ intheader_ size_ bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- http_max_ intinitial_ line_ length_ bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indices_fielddata_ intcache_ size_ percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indices_memory_ intindex_ buffer_ size_ percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indices_memory_ intmax_ index_ buffer_ size_ mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indices_memory_ intmin_ index_ buffer_ size_ mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indices_queries_ intcache_ size_ percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indices_query_ intbool_ max_ clause_ count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indices_recovery_ intmax_ concurrent_ file_ chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indices_recovery_ intmax_ mb_ per_ sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ism_enabled bool
- Specifies whether ISM is enabled or not. Default: true
- ism_history_ boolenabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ism_history_ intmax_ age_ hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ism_history_ intmax_ docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ism_history_ introllover_ check_ period_ hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ism_history_ introllover_ retention_ period_ days 
- Length of time long audit history indices are kept, in days. Default: 30
- override_main_ boolresponse_ version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- plugins_alerting_ boolfilter_ by_ backend_ roles_ enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindex_remote_ Sequence[str]whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- script_max_ strcompilations_ rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- search_max_ intbuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- thread_pool_ intanalyze_ queue_ size 
- Size of queue for operations in the analyze thread pool.
- thread_pool_ intanalyze_ size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intforce_ merge_ size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intget_ queue_ size 
- Size of queue for operations in the get thread pool.
- thread_pool_ intget_ size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intsearch_ queue_ size 
- Size of queue for operations in the search thread pool.
- thread_pool_ intsearch_ size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intsearch_ throttled_ queue_ size 
- Size of queue for operations in the search throttled thread pool.
- thread_pool_ intsearch_ throttled_ size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- thread_pool_ intwrite_ queue_ size 
- Size of queue for operations in the write thread pool.
- thread_pool_ intwrite_ size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- actionAuto BooleanCreate Index Enabled 
- Specifies whether ISM is enabled or not. Default: true
- actionDestructive BooleanRequires Name 
- Specifies whether to require explicit index names when deleting indices.
- clusterId String
- The ID of the target Opensearch cluster.
- clusterMax NumberShards Per Node 
- Maximum number of shards allowed per data node.
- clusterRouting NumberAllocation Node Concurrent Recoveries 
- Maximum concurrent incoming/outgoing shard recoveries (normally replicas) are allowed to happen per node. Default: 2
- enableSecurity BooleanAudit 
- Specifies whether to allow security audit logging. Default: false
- httpMax NumberContent Length Bytes 
- Maximum content length for HTTP requests to the OpenSearch HTTP API, in bytes. Default: 100000000
- httpMax NumberHeader Size Bytes 
- Maximum size of allowed headers, in bytes. Default: 8192
- httpMax NumberInitial Line Length Bytes 
- Maximum length of an HTTP URL, in bytes. Default: 4096
- indicesFielddata NumberCache Size Percentage 
- Maximum amount of heap memory used for field data cache, expressed as a percentage. Decreasing the value too much will increase overhead of loading field data. Increasing the value too much will decrease amount of heap available for other operations.
- indicesMemory NumberIndex Buffer Size Percentage 
- Total amount of heap used for indexing buffer before writing segments to disk, expressed as a percentage. Too low value will slow down indexing; too high value will increase indexing performance but causes performance issues for query performance. Default: 10
- indicesMemory NumberMax Index Buffer Size Mb 
- Maximum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. The default is unbounded.
- indicesMemory NumberMin Index Buffer Size Mb 
- Minimum amount of heap used for indexing buffer before writing segments to disk, in mb. Works in conjunction with indices_memory_index_buffer_size_percentage, each being enforced. Default: 48
- indicesQueries NumberCache Size Percentage 
- Maximum amount of heap used for query cache. Too low value will decrease query performance and increase performance for other operations; too high value will cause issues with other functionality. Default: 10
- indicesQuery NumberBool Max Clause Count 
- Maximum number of clauses Lucene BooleanQuery can have. Only increase it if necessary, as it may cause performance issues. Default: 1024
- indicesRecovery NumberMax Concurrent File Chunks 
- Maximum number of file chunks sent in parallel for each recovery. Default: 2
- indicesRecovery NumberMax Mb Per Sec 
- Limits total inbound and outbound recovery traffic for each node, expressed in mb per second. Applies to both peer recoveries as well as snapshot recoveries (i.e., restores from a snapshot). Default: 40
- ismEnabled Boolean
- Specifies whether ISM is enabled or not. Default: true
- ismHistory BooleanEnabled 
- Specifies whether audit history is enabled or not. The logs from ISM are automatically indexed to a logs document. Default: true
- ismHistory NumberMax Age Hours 
- Maximum age before rolling over the audit history index, in hours. Default: 24
- ismHistory NumberMax Docs 
- Maximum number of documents before rolling over the audit history index. Default: 2500000
- ismHistory NumberRollover Check Period Hours 
- The time between rollover checks for the audit history index, in hours. Default: 8
- ismHistory NumberRollover Retention Period Days 
- Length of time long audit history indices are kept, in days. Default: 30
- overrideMain BooleanResponse Version 
- Compatibility mode sets OpenSearch to report its version as 7.10 so clients continue to work. Default: false
- pluginsAlerting BooleanFilter By Backend Roles Enabled 
- Enable or disable filtering of alerting by backend roles. Default: false
- reindexRemote List<String>Whitelists 
- Allowlist of remote IP addresses for reindexing. Changing this value will cause all OpenSearch instances to restart.
- scriptMax StringCompilations Rate 
- Limits the number of inline script compilations within a period of time. Default is use-context
- searchMax NumberBuckets 
- Maximum number of aggregation buckets allowed in a single response. Default: 10000
- threadPool NumberAnalyze Queue Size 
- Size of queue for operations in the analyze thread pool.
- threadPool NumberAnalyze Size 
- Number of workers in the analyze operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberForce Merge Size 
- Number of workers in the force merge operation thread pool. This pool is used for forcing a merge between shards of one or more indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberGet Queue Size 
- Size of queue for operations in the get thread pool.
- threadPool NumberGet Size 
- Number of workers in the get operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberSearch Queue Size 
- Size of queue for operations in the search thread pool.
- threadPool NumberSearch Size 
- Number of workers in the search operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberSearch Throttled Queue Size 
- Size of queue for operations in the search throttled thread pool.
- threadPool NumberSearch Throttled Size 
- Number of workers in the search throttled operation thread pool. This pool is used for searching frozen indices. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
- threadPool NumberWrite Queue Size 
- Size of queue for operations in the write thread pool.
- threadPool NumberWrite Size 
- Number of workers in the write operation thread pool. Do note this may have maximum value depending on CPU count - value is automatically lowered if set to higher than maximum value.
Import
A Opensearch database cluster’s configuration can be imported using the id the parent cluster, e.g.
$ pulumi import digitalocean:index/databaseOpensearchConfig:DatabaseOpensearchConfig example 4b62829a-9c42-465b-aaa3-84051048e712
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- DigitalOcean pulumi/pulumi-digitalocean
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the digitaloceanTerraform Provider.