Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opensearch Provider
  3. API Docs
  4. ClusterSettings
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

opensearch.ClusterSettings

Explore with Pulumi AI

opensearch logo
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
opensearch-project/terraform-provider-opensearch

    Manages a cluster’s (persistent) settings.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as opensearch from "@pulumi/opensearch";

const global = new opensearch.ClusterSettings("global", {
    actionAutoCreateIndex: "my-index-000001,index10,-index1*,+ind*",
    clusterMaxShardsPerNode: 10,
});

    import pulumi
import pulumi_opensearch as opensearch

global_ = opensearch.ClusterSettings("global",
    action_auto_create_index="my-index-000001,index10,-index1*,+ind*",
    cluster_max_shards_per_node=10)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opensearch/v2/opensearch"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opensearch.NewClusterSettings(ctx, "global", &opensearch.ClusterSettingsArgs{
			ActionAutoCreateIndex:   pulumi.String("my-index-000001,index10,-index1*,+ind*"),
			ClusterMaxShardsPerNode: pulumi.Float64(10),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opensearch = Pulumi.Opensearch;

return await Deployment.RunAsync(() => 
{
    var @global = new Opensearch.ClusterSettings("global", new()
    {
        ActionAutoCreateIndex = "my-index-000001,index10,-index1*,+ind*",
        ClusterMaxShardsPerNode = 10,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opensearch.ClusterSettings;
import com.pulumi.opensearch.ClusterSettingsArgs;
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 global = new ClusterSettings("global", ClusterSettingsArgs.builder()
            .actionAutoCreateIndex("my-index-000001,index10,-index1*,+ind*")
            .clusterMaxShardsPerNode(10)
            .build());

    }
}

    resources:
  global:
    type: opensearch:ClusterSettings
    properties:
      actionAutoCreateIndex: my-index-000001,index10,-index1*,+ind*
      clusterMaxShardsPerNode: 10

    Create ClusterSettings Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClusterSettings(name: string, args?: ClusterSettingsArgs, opts?: CustomResourceOptions);
    @overload
def ClusterSettings(resource_name: str,
                    args: Optional[ClusterSettingsArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def ClusterSettings(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    action_auto_create_index: Optional[str] = None,
                    action_destructive_requires_name: Optional[bool] = None,
                    cluster_blocks_read_only: Optional[bool] = None,
                    cluster_blocks_read_only_allow_delete: Optional[bool] = None,
                    cluster_indices_close_enable: Optional[bool] = None,
                    cluster_info_update_interval: Optional[str] = None,
                    cluster_max_shards_per_node: Optional[float] = None,
                    cluster_max_shards_per_node_frozen: Optional[float] = None,
                    cluster_no_master_block: Optional[str] = None,
                    cluster_persistent_tasks_allocation_enable: Optional[str] = None,
                    cluster_persistent_tasks_allocation_recheck_interval: Optional[str] = None,
                    cluster_routing_allocation_allow_rebalance: Optional[str] = None,
                    cluster_routing_allocation_awareness_attributes: Optional[str] = None,
                    cluster_routing_allocation_awareness_force_zone_values: Optional[Sequence[str]] = None,
                    cluster_routing_allocation_balance_index: Optional[float] = None,
                    cluster_routing_allocation_balance_shard: Optional[float] = None,
                    cluster_routing_allocation_balance_threshold: Optional[float] = None,
                    cluster_routing_allocation_cluster_concurrent_rebalance: Optional[float] = None,
                    cluster_routing_allocation_disk_include_relocations: Optional[bool] = None,
                    cluster_routing_allocation_disk_threshold_enabled: Optional[bool] = None,
                    cluster_routing_allocation_disk_watermark_high: Optional[str] = None,
                    cluster_routing_allocation_disk_watermark_low: Optional[str] = None,
                    cluster_routing_allocation_enable: Optional[str] = None,
                    cluster_routing_allocation_node_concurrent_incoming_recoveries: Optional[float] = None,
                    cluster_routing_allocation_node_concurrent_outgoing_recoveries: Optional[float] = None,
                    cluster_routing_allocation_node_concurrent_recoveries: Optional[float] = None,
                    cluster_routing_allocation_node_initial_primaries_recoveries: Optional[float] = None,
                    cluster_routing_allocation_same_shard_host: Optional[bool] = None,
                    cluster_routing_allocation_total_shards_per_node: Optional[float] = None,
                    cluster_routing_rebalance_enable: Optional[str] = None,
                    cluster_search_request_slowlog_level: Optional[str] = None,
                    cluster_search_request_slowlog_threshold_debug: Optional[str] = None,
                    cluster_search_request_slowlog_threshold_info: Optional[str] = None,
                    cluster_search_request_slowlog_threshold_trace: Optional[str] = None,
                    cluster_search_request_slowlog_threshold_warn: Optional[str] = None,
                    cluster_settings_id: Optional[str] = None,
                    indices_breaker_fielddata_limit: Optional[str] = None,
                    indices_breaker_fielddata_overhead: Optional[float] = None,
                    indices_breaker_request_limit: Optional[str] = None,
                    indices_breaker_request_overhead: Optional[float] = None,
                    indices_breaker_total_limit: Optional[str] = None,
                    indices_recovery_max_bytes_per_sec: Optional[str] = None,
                    network_breaker_inflight_requests_limit: Optional[str] = None,
                    network_breaker_inflight_requests_overhead: Optional[float] = None,
                    script_max_compilations_rate: Optional[str] = None,
                    search_default_search_timeout: Optional[str] = None)
    func NewClusterSettings(ctx *Context, name string, args *ClusterSettingsArgs, opts ...ResourceOption) (*ClusterSettings, error)
    public ClusterSettings(string name, ClusterSettingsArgs? args = null, CustomResourceOptions? opts = null)
    public ClusterSettings(String name, ClusterSettingsArgs args)
public ClusterSettings(String name, ClusterSettingsArgs args, CustomResourceOptions options)

    type: opensearch:ClusterSettings
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 ClusterSettingsArgs
    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 ClusterSettingsArgs
    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 ClusterSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterSettingsArgs
    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 clusterSettingsResource = new Opensearch.ClusterSettings("clusterSettingsResource", new()
{
    ActionAutoCreateIndex = "string",
    ActionDestructiveRequiresName = false,
    ClusterBlocksReadOnly = false,
    ClusterBlocksReadOnlyAllowDelete = false,
    ClusterIndicesCloseEnable = false,
    ClusterInfoUpdateInterval = "string",
    ClusterMaxShardsPerNode = 0,
    ClusterMaxShardsPerNodeFrozen = 0,
    ClusterNoMasterBlock = "string",
    ClusterPersistentTasksAllocationEnable = "string",
    ClusterPersistentTasksAllocationRecheckInterval = "string",
    ClusterRoutingAllocationAllowRebalance = "string",
    ClusterRoutingAllocationAwarenessAttributes = "string",
    ClusterRoutingAllocationAwarenessForceZoneValues = new[]
    {
        "string",
    },
    ClusterRoutingAllocationBalanceIndex = 0,
    ClusterRoutingAllocationBalanceShard = 0,
    ClusterRoutingAllocationBalanceThreshold = 0,
    ClusterRoutingAllocationClusterConcurrentRebalance = 0,
    ClusterRoutingAllocationDiskIncludeRelocations = false,
    ClusterRoutingAllocationDiskThresholdEnabled = false,
    ClusterRoutingAllocationDiskWatermarkHigh = "string",
    ClusterRoutingAllocationDiskWatermarkLow = "string",
    ClusterRoutingAllocationEnable = "string",
    ClusterRoutingAllocationNodeConcurrentIncomingRecoveries = 0,
    ClusterRoutingAllocationNodeConcurrentOutgoingRecoveries = 0,
    ClusterRoutingAllocationNodeConcurrentRecoveries = 0,
    ClusterRoutingAllocationNodeInitialPrimariesRecoveries = 0,
    ClusterRoutingAllocationSameShardHost = false,
    ClusterRoutingAllocationTotalShardsPerNode = 0,
    ClusterRoutingRebalanceEnable = "string",
    ClusterSearchRequestSlowlogLevel = "string",
    ClusterSearchRequestSlowlogThresholdDebug = "string",
    ClusterSearchRequestSlowlogThresholdInfo = "string",
    ClusterSearchRequestSlowlogThresholdTrace = "string",
    ClusterSearchRequestSlowlogThresholdWarn = "string",
    ClusterSettingsId = "string",
    IndicesBreakerFielddataLimit = "string",
    IndicesBreakerFielddataOverhead = 0,
    IndicesBreakerRequestLimit = "string",
    IndicesBreakerRequestOverhead = 0,
    IndicesBreakerTotalLimit = "string",
    IndicesRecoveryMaxBytesPerSec = "string",
    NetworkBreakerInflightRequestsLimit = "string",
    NetworkBreakerInflightRequestsOverhead = 0,
    ScriptMaxCompilationsRate = "string",
    SearchDefaultSearchTimeout = "string",
});

    example, err := opensearch.NewClusterSettings(ctx, "clusterSettingsResource", &opensearch.ClusterSettingsArgs{
	ActionAutoCreateIndex:                           pulumi.String("string"),
	ActionDestructiveRequiresName:                   pulumi.Bool(false),
	ClusterBlocksReadOnly:                           pulumi.Bool(false),
	ClusterBlocksReadOnlyAllowDelete:                pulumi.Bool(false),
	ClusterIndicesCloseEnable:                       pulumi.Bool(false),
	ClusterInfoUpdateInterval:                       pulumi.String("string"),
	ClusterMaxShardsPerNode:                         pulumi.Float64(0),
	ClusterMaxShardsPerNodeFrozen:                   pulumi.Float64(0),
	ClusterNoMasterBlock:                            pulumi.String("string"),
	ClusterPersistentTasksAllocationEnable:          pulumi.String("string"),
	ClusterPersistentTasksAllocationRecheckInterval: pulumi.String("string"),
	ClusterRoutingAllocationAllowRebalance:          pulumi.String("string"),
	ClusterRoutingAllocationAwarenessAttributes:     pulumi.String("string"),
	ClusterRoutingAllocationAwarenessForceZoneValues: pulumi.StringArray{
		pulumi.String("string"),
	},
	ClusterRoutingAllocationBalanceIndex:                     pulumi.Float64(0),
	ClusterRoutingAllocationBalanceShard:                     pulumi.Float64(0),
	ClusterRoutingAllocationBalanceThreshold:                 pulumi.Float64(0),
	ClusterRoutingAllocationClusterConcurrentRebalance:       pulumi.Float64(0),
	ClusterRoutingAllocationDiskIncludeRelocations:           pulumi.Bool(false),
	ClusterRoutingAllocationDiskThresholdEnabled:             pulumi.Bool(false),
	ClusterRoutingAllocationDiskWatermarkHigh:                pulumi.String("string"),
	ClusterRoutingAllocationDiskWatermarkLow:                 pulumi.String("string"),
	ClusterRoutingAllocationEnable:                           pulumi.String("string"),
	ClusterRoutingAllocationNodeConcurrentIncomingRecoveries: pulumi.Float64(0),
	ClusterRoutingAllocationNodeConcurrentOutgoingRecoveries: pulumi.Float64(0),
	ClusterRoutingAllocationNodeConcurrentRecoveries:         pulumi.Float64(0),
	ClusterRoutingAllocationNodeInitialPrimariesRecoveries:   pulumi.Float64(0),
	ClusterRoutingAllocationSameShardHost:                    pulumi.Bool(false),
	ClusterRoutingAllocationTotalShardsPerNode:               pulumi.Float64(0),
	ClusterRoutingRebalanceEnable:                            pulumi.String("string"),
	ClusterSearchRequestSlowlogLevel:                         pulumi.String("string"),
	ClusterSearchRequestSlowlogThresholdDebug:                pulumi.String("string"),
	ClusterSearchRequestSlowlogThresholdInfo:                 pulumi.String("string"),
	ClusterSearchRequestSlowlogThresholdTrace:                pulumi.String("string"),
	ClusterSearchRequestSlowlogThresholdWarn:                 pulumi.String("string"),
	ClusterSettingsId:                                        pulumi.String("string"),
	IndicesBreakerFielddataLimit:                             pulumi.String("string"),
	IndicesBreakerFielddataOverhead:                          pulumi.Float64(0),
	IndicesBreakerRequestLimit:                               pulumi.String("string"),
	IndicesBreakerRequestOverhead:                            pulumi.Float64(0),
	IndicesBreakerTotalLimit:                                 pulumi.String("string"),
	IndicesRecoveryMaxBytesPerSec:                            pulumi.String("string"),
	NetworkBreakerInflightRequestsLimit:                      pulumi.String("string"),
	NetworkBreakerInflightRequestsOverhead:                   pulumi.Float64(0),
	ScriptMaxCompilationsRate:                                pulumi.String("string"),
	SearchDefaultSearchTimeout:                               pulumi.String("string"),
})

    var clusterSettingsResource = new ClusterSettings("clusterSettingsResource", ClusterSettingsArgs.builder()
    .actionAutoCreateIndex("string")
    .actionDestructiveRequiresName(false)
    .clusterBlocksReadOnly(false)
    .clusterBlocksReadOnlyAllowDelete(false)
    .clusterIndicesCloseEnable(false)
    .clusterInfoUpdateInterval("string")
    .clusterMaxShardsPerNode(0)
    .clusterMaxShardsPerNodeFrozen(0)
    .clusterNoMasterBlock("string")
    .clusterPersistentTasksAllocationEnable("string")
    .clusterPersistentTasksAllocationRecheckInterval("string")
    .clusterRoutingAllocationAllowRebalance("string")
    .clusterRoutingAllocationAwarenessAttributes("string")
    .clusterRoutingAllocationAwarenessForceZoneValues("string")
    .clusterRoutingAllocationBalanceIndex(0)
    .clusterRoutingAllocationBalanceShard(0)
    .clusterRoutingAllocationBalanceThreshold(0)
    .clusterRoutingAllocationClusterConcurrentRebalance(0)
    .clusterRoutingAllocationDiskIncludeRelocations(false)
    .clusterRoutingAllocationDiskThresholdEnabled(false)
    .clusterRoutingAllocationDiskWatermarkHigh("string")
    .clusterRoutingAllocationDiskWatermarkLow("string")
    .clusterRoutingAllocationEnable("string")
    .clusterRoutingAllocationNodeConcurrentIncomingRecoveries(0)
    .clusterRoutingAllocationNodeConcurrentOutgoingRecoveries(0)
    .clusterRoutingAllocationNodeConcurrentRecoveries(0)
    .clusterRoutingAllocationNodeInitialPrimariesRecoveries(0)
    .clusterRoutingAllocationSameShardHost(false)
    .clusterRoutingAllocationTotalShardsPerNode(0)
    .clusterRoutingRebalanceEnable("string")
    .clusterSearchRequestSlowlogLevel("string")
    .clusterSearchRequestSlowlogThresholdDebug("string")
    .clusterSearchRequestSlowlogThresholdInfo("string")
    .clusterSearchRequestSlowlogThresholdTrace("string")
    .clusterSearchRequestSlowlogThresholdWarn("string")
    .clusterSettingsId("string")
    .indicesBreakerFielddataLimit("string")
    .indicesBreakerFielddataOverhead(0)
    .indicesBreakerRequestLimit("string")
    .indicesBreakerRequestOverhead(0)
    .indicesBreakerTotalLimit("string")
    .indicesRecoveryMaxBytesPerSec("string")
    .networkBreakerInflightRequestsLimit("string")
    .networkBreakerInflightRequestsOverhead(0)
    .scriptMaxCompilationsRate("string")
    .searchDefaultSearchTimeout("string")
    .build());

    cluster_settings_resource = opensearch.ClusterSettings("clusterSettingsResource",
    action_auto_create_index="string",
    action_destructive_requires_name=False,
    cluster_blocks_read_only=False,
    cluster_blocks_read_only_allow_delete=False,
    cluster_indices_close_enable=False,
    cluster_info_update_interval="string",
    cluster_max_shards_per_node=0,
    cluster_max_shards_per_node_frozen=0,
    cluster_no_master_block="string",
    cluster_persistent_tasks_allocation_enable="string",
    cluster_persistent_tasks_allocation_recheck_interval="string",
    cluster_routing_allocation_allow_rebalance="string",
    cluster_routing_allocation_awareness_attributes="string",
    cluster_routing_allocation_awareness_force_zone_values=["string"],
    cluster_routing_allocation_balance_index=0,
    cluster_routing_allocation_balance_shard=0,
    cluster_routing_allocation_balance_threshold=0,
    cluster_routing_allocation_cluster_concurrent_rebalance=0,
    cluster_routing_allocation_disk_include_relocations=False,
    cluster_routing_allocation_disk_threshold_enabled=False,
    cluster_routing_allocation_disk_watermark_high="string",
    cluster_routing_allocation_disk_watermark_low="string",
    cluster_routing_allocation_enable="string",
    cluster_routing_allocation_node_concurrent_incoming_recoveries=0,
    cluster_routing_allocation_node_concurrent_outgoing_recoveries=0,
    cluster_routing_allocation_node_concurrent_recoveries=0,
    cluster_routing_allocation_node_initial_primaries_recoveries=0,
    cluster_routing_allocation_same_shard_host=False,
    cluster_routing_allocation_total_shards_per_node=0,
    cluster_routing_rebalance_enable="string",
    cluster_search_request_slowlog_level="string",
    cluster_search_request_slowlog_threshold_debug="string",
    cluster_search_request_slowlog_threshold_info="string",
    cluster_search_request_slowlog_threshold_trace="string",
    cluster_search_request_slowlog_threshold_warn="string",
    cluster_settings_id="string",
    indices_breaker_fielddata_limit="string",
    indices_breaker_fielddata_overhead=0,
    indices_breaker_request_limit="string",
    indices_breaker_request_overhead=0,
    indices_breaker_total_limit="string",
    indices_recovery_max_bytes_per_sec="string",
    network_breaker_inflight_requests_limit="string",
    network_breaker_inflight_requests_overhead=0,
    script_max_compilations_rate="string",
    search_default_search_timeout="string")

    const clusterSettingsResource = new opensearch.ClusterSettings("clusterSettingsResource", {
    actionAutoCreateIndex: "string",
    actionDestructiveRequiresName: false,
    clusterBlocksReadOnly: false,
    clusterBlocksReadOnlyAllowDelete: false,
    clusterIndicesCloseEnable: false,
    clusterInfoUpdateInterval: "string",
    clusterMaxShardsPerNode: 0,
    clusterMaxShardsPerNodeFrozen: 0,
    clusterNoMasterBlock: "string",
    clusterPersistentTasksAllocationEnable: "string",
    clusterPersistentTasksAllocationRecheckInterval: "string",
    clusterRoutingAllocationAllowRebalance: "string",
    clusterRoutingAllocationAwarenessAttributes: "string",
    clusterRoutingAllocationAwarenessForceZoneValues: ["string"],
    clusterRoutingAllocationBalanceIndex: 0,
    clusterRoutingAllocationBalanceShard: 0,
    clusterRoutingAllocationBalanceThreshold: 0,
    clusterRoutingAllocationClusterConcurrentRebalance: 0,
    clusterRoutingAllocationDiskIncludeRelocations: false,
    clusterRoutingAllocationDiskThresholdEnabled: false,
    clusterRoutingAllocationDiskWatermarkHigh: "string",
    clusterRoutingAllocationDiskWatermarkLow: "string",
    clusterRoutingAllocationEnable: "string",
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries: 0,
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries: 0,
    clusterRoutingAllocationNodeConcurrentRecoveries: 0,
    clusterRoutingAllocationNodeInitialPrimariesRecoveries: 0,
    clusterRoutingAllocationSameShardHost: false,
    clusterRoutingAllocationTotalShardsPerNode: 0,
    clusterRoutingRebalanceEnable: "string",
    clusterSearchRequestSlowlogLevel: "string",
    clusterSearchRequestSlowlogThresholdDebug: "string",
    clusterSearchRequestSlowlogThresholdInfo: "string",
    clusterSearchRequestSlowlogThresholdTrace: "string",
    clusterSearchRequestSlowlogThresholdWarn: "string",
    clusterSettingsId: "string",
    indicesBreakerFielddataLimit: "string",
    indicesBreakerFielddataOverhead: 0,
    indicesBreakerRequestLimit: "string",
    indicesBreakerRequestOverhead: 0,
    indicesBreakerTotalLimit: "string",
    indicesRecoveryMaxBytesPerSec: "string",
    networkBreakerInflightRequestsLimit: "string",
    networkBreakerInflightRequestsOverhead: 0,
    scriptMaxCompilationsRate: "string",
    searchDefaultSearchTimeout: "string",
});

    type: opensearch:ClusterSettings
properties:
    actionAutoCreateIndex: string
    actionDestructiveRequiresName: false
    clusterBlocksReadOnly: false
    clusterBlocksReadOnlyAllowDelete: false
    clusterIndicesCloseEnable: false
    clusterInfoUpdateInterval: string
    clusterMaxShardsPerNode: 0
    clusterMaxShardsPerNodeFrozen: 0
    clusterNoMasterBlock: string
    clusterPersistentTasksAllocationEnable: string
    clusterPersistentTasksAllocationRecheckInterval: string
    clusterRoutingAllocationAllowRebalance: string
    clusterRoutingAllocationAwarenessAttributes: string
    clusterRoutingAllocationAwarenessForceZoneValues:
        - string
    clusterRoutingAllocationBalanceIndex: 0
    clusterRoutingAllocationBalanceShard: 0
    clusterRoutingAllocationBalanceThreshold: 0
    clusterRoutingAllocationClusterConcurrentRebalance: 0
    clusterRoutingAllocationDiskIncludeRelocations: false
    clusterRoutingAllocationDiskThresholdEnabled: false
    clusterRoutingAllocationDiskWatermarkHigh: string
    clusterRoutingAllocationDiskWatermarkLow: string
    clusterRoutingAllocationEnable: string
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries: 0
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries: 0
    clusterRoutingAllocationNodeConcurrentRecoveries: 0
    clusterRoutingAllocationNodeInitialPrimariesRecoveries: 0
    clusterRoutingAllocationSameShardHost: false
    clusterRoutingAllocationTotalShardsPerNode: 0
    clusterRoutingRebalanceEnable: string
    clusterSearchRequestSlowlogLevel: string
    clusterSearchRequestSlowlogThresholdDebug: string
    clusterSearchRequestSlowlogThresholdInfo: string
    clusterSearchRequestSlowlogThresholdTrace: string
    clusterSearchRequestSlowlogThresholdWarn: string
    clusterSettingsId: string
    indicesBreakerFielddataLimit: string
    indicesBreakerFielddataOverhead: 0
    indicesBreakerRequestLimit: string
    indicesBreakerRequestOverhead: 0
    indicesBreakerTotalLimit: string
    indicesRecoveryMaxBytesPerSec: string
    networkBreakerInflightRequestsLimit: string
    networkBreakerInflightRequestsOverhead: 0
    scriptMaxCompilationsRate: string
    searchDefaultSearchTimeout: string

    ClusterSettings 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 ClusterSettings resource accepts the following input properties:

    ActionAutoCreateIndex string
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    ActionDestructiveRequiresName bool
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    ClusterBlocksReadOnly bool
    Make the whole cluster read only and metadata is not allowed to be modified
    ClusterBlocksReadOnlyAllowDelete bool
    Make the whole cluster read only, but allows to delete indices to free up resources
    ClusterIndicesCloseEnable bool
    If false, you cannot close open indices
    ClusterInfoUpdateInterval string
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    ClusterMaxShardsPerNode double
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    ClusterMaxShardsPerNodeFrozen double
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    ClusterNoMasterBlock string
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    ClusterPersistentTasksAllocationEnable string
    Whether allocation for persistent tasks is active (all, none)
    ClusterPersistentTasksAllocationRecheckInterval string
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    ClusterRoutingAllocationAllowRebalance string
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    ClusterRoutingAllocationAwarenessAttributes string
    Use custom node attributes to take hardware configuration into account when allocating shards
    ClusterRoutingAllocationAwarenessForceZoneValues List<string>
    A list of zones for awareness allocation.
    ClusterRoutingAllocationBalanceIndex double
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    ClusterRoutingAllocationBalanceShard double
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    ClusterRoutingAllocationBalanceThreshold double
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    ClusterRoutingAllocationClusterConcurrentRebalance double
    How many concurrent shard rebalances are allowed cluster wide
    ClusterRoutingAllocationDiskIncludeRelocations bool
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    ClusterRoutingAllocationDiskThresholdEnabled bool
    Whether the disk allocation decider is active
    ClusterRoutingAllocationDiskWatermarkHigh string
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    ClusterRoutingAllocationDiskWatermarkLow string
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    ClusterRoutingAllocationEnable string
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    ClusterRoutingAllocationNodeConcurrentIncomingRecoveries double
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentOutgoingRecoveries double
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentRecoveries double
    A shortcut to set both incoming and outgoing recoveries
    ClusterRoutingAllocationNodeInitialPrimariesRecoveries double
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    ClusterRoutingAllocationSameShardHost bool
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    ClusterRoutingAllocationTotalShardsPerNode double
    Maximum number of primary and replica shards allocated to each node
    ClusterRoutingRebalanceEnable string
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    ClusterSearchRequestSlowlogLevel string
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    ClusterSearchRequestSlowlogThresholdDebug string
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    ClusterSearchRequestSlowlogThresholdInfo string
    Slowlog threshold for INFO level search requests (e.g., 5s)
    ClusterSearchRequestSlowlogThresholdTrace string
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    ClusterSearchRequestSlowlogThresholdWarn string
    Slowlog threshold for WARN level search requests (e.g., 10s)
    ClusterSettingsId string
    The ID of this resource.
    IndicesBreakerFielddataLimit string
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    IndicesBreakerFielddataOverhead double
    A constant that all field data estimations are multiplied by
    IndicesBreakerRequestLimit string
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    IndicesBreakerRequestOverhead double
    A constant that all request estimations are multiplied by
    IndicesBreakerTotalLimit string
    The percentage of total amount of memory that can be used across all breakers
    IndicesRecoveryMaxBytesPerSec string
    Maximum total inbound and outbound recovery traffic for each node, in mb
    NetworkBreakerInflightRequestsLimit string
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    NetworkBreakerInflightRequestsOverhead double
    A constant that all in flight requests estimations are multiplied by
    ScriptMaxCompilationsRate string
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    SearchDefaultSearchTimeout string
    A time string setting a cluster-wide default timeout for all search requests
    ActionAutoCreateIndex string
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    ActionDestructiveRequiresName bool
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    ClusterBlocksReadOnly bool
    Make the whole cluster read only and metadata is not allowed to be modified
    ClusterBlocksReadOnlyAllowDelete bool
    Make the whole cluster read only, but allows to delete indices to free up resources
    ClusterIndicesCloseEnable bool
    If false, you cannot close open indices
    ClusterInfoUpdateInterval string
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    ClusterMaxShardsPerNode float64
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    ClusterMaxShardsPerNodeFrozen float64
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    ClusterNoMasterBlock string
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    ClusterPersistentTasksAllocationEnable string
    Whether allocation for persistent tasks is active (all, none)
    ClusterPersistentTasksAllocationRecheckInterval string
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    ClusterRoutingAllocationAllowRebalance string
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    ClusterRoutingAllocationAwarenessAttributes string
    Use custom node attributes to take hardware configuration into account when allocating shards
    ClusterRoutingAllocationAwarenessForceZoneValues []string
    A list of zones for awareness allocation.
    ClusterRoutingAllocationBalanceIndex float64
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    ClusterRoutingAllocationBalanceShard float64
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    ClusterRoutingAllocationBalanceThreshold float64
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    ClusterRoutingAllocationClusterConcurrentRebalance float64
    How many concurrent shard rebalances are allowed cluster wide
    ClusterRoutingAllocationDiskIncludeRelocations bool
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    ClusterRoutingAllocationDiskThresholdEnabled bool
    Whether the disk allocation decider is active
    ClusterRoutingAllocationDiskWatermarkHigh string
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    ClusterRoutingAllocationDiskWatermarkLow string
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    ClusterRoutingAllocationEnable string
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    ClusterRoutingAllocationNodeConcurrentIncomingRecoveries float64
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentOutgoingRecoveries float64
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentRecoveries float64
    A shortcut to set both incoming and outgoing recoveries
    ClusterRoutingAllocationNodeInitialPrimariesRecoveries float64
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    ClusterRoutingAllocationSameShardHost bool
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    ClusterRoutingAllocationTotalShardsPerNode float64
    Maximum number of primary and replica shards allocated to each node
    ClusterRoutingRebalanceEnable string
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    ClusterSearchRequestSlowlogLevel string
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    ClusterSearchRequestSlowlogThresholdDebug string
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    ClusterSearchRequestSlowlogThresholdInfo string
    Slowlog threshold for INFO level search requests (e.g., 5s)
    ClusterSearchRequestSlowlogThresholdTrace string
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    ClusterSearchRequestSlowlogThresholdWarn string
    Slowlog threshold for WARN level search requests (e.g., 10s)
    ClusterSettingsId string
    The ID of this resource.
    IndicesBreakerFielddataLimit string
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    IndicesBreakerFielddataOverhead float64
    A constant that all field data estimations are multiplied by
    IndicesBreakerRequestLimit string
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    IndicesBreakerRequestOverhead float64
    A constant that all request estimations are multiplied by
    IndicesBreakerTotalLimit string
    The percentage of total amount of memory that can be used across all breakers
    IndicesRecoveryMaxBytesPerSec string
    Maximum total inbound and outbound recovery traffic for each node, in mb
    NetworkBreakerInflightRequestsLimit string
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    NetworkBreakerInflightRequestsOverhead float64
    A constant that all in flight requests estimations are multiplied by
    ScriptMaxCompilationsRate string
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    SearchDefaultSearchTimeout string
    A time string setting a cluster-wide default timeout for all search requests
    actionAutoCreateIndex String
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    actionDestructiveRequiresName Boolean
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    clusterBlocksReadOnly Boolean
    Make the whole cluster read only and metadata is not allowed to be modified
    clusterBlocksReadOnlyAllowDelete Boolean
    Make the whole cluster read only, but allows to delete indices to free up resources
    clusterIndicesCloseEnable Boolean
    If false, you cannot close open indices
    clusterInfoUpdateInterval String
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    clusterMaxShardsPerNode Double
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    clusterMaxShardsPerNodeFrozen Double
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    clusterNoMasterBlock String
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    clusterPersistentTasksAllocationEnable String
    Whether allocation for persistent tasks is active (all, none)
    clusterPersistentTasksAllocationRecheckInterval String
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    clusterRoutingAllocationAllowRebalance String
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    clusterRoutingAllocationAwarenessAttributes String
    Use custom node attributes to take hardware configuration into account when allocating shards
    clusterRoutingAllocationAwarenessForceZoneValues List<String>
    A list of zones for awareness allocation.
    clusterRoutingAllocationBalanceIndex Double
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    clusterRoutingAllocationBalanceShard Double
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    clusterRoutingAllocationBalanceThreshold Double
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    clusterRoutingAllocationClusterConcurrentRebalance Double
    How many concurrent shard rebalances are allowed cluster wide
    clusterRoutingAllocationDiskIncludeRelocations Boolean
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    clusterRoutingAllocationDiskThresholdEnabled Boolean
    Whether the disk allocation decider is active
    clusterRoutingAllocationDiskWatermarkHigh String
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    clusterRoutingAllocationDiskWatermarkLow String
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    clusterRoutingAllocationEnable String
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries Double
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries Double
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentRecoveries Double
    A shortcut to set both incoming and outgoing recoveries
    clusterRoutingAllocationNodeInitialPrimariesRecoveries Double
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    clusterRoutingAllocationSameShardHost Boolean
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    clusterRoutingAllocationTotalShardsPerNode Double
    Maximum number of primary and replica shards allocated to each node
    clusterRoutingRebalanceEnable String
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    clusterSearchRequestSlowlogLevel String
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    clusterSearchRequestSlowlogThresholdDebug String
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    clusterSearchRequestSlowlogThresholdInfo String
    Slowlog threshold for INFO level search requests (e.g., 5s)
    clusterSearchRequestSlowlogThresholdTrace String
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    clusterSearchRequestSlowlogThresholdWarn String
    Slowlog threshold for WARN level search requests (e.g., 10s)
    clusterSettingsId String
    The ID of this resource.
    indicesBreakerFielddataLimit String
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indicesBreakerFielddataOverhead Double
    A constant that all field data estimations are multiplied by
    indicesBreakerRequestLimit String
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indicesBreakerRequestOverhead Double
    A constant that all request estimations are multiplied by
    indicesBreakerTotalLimit String
    The percentage of total amount of memory that can be used across all breakers
    indicesRecoveryMaxBytesPerSec String
    Maximum total inbound and outbound recovery traffic for each node, in mb
    networkBreakerInflightRequestsLimit String
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    networkBreakerInflightRequestsOverhead Double
    A constant that all in flight requests estimations are multiplied by
    scriptMaxCompilationsRate String
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    searchDefaultSearchTimeout String
    A time string setting a cluster-wide default timeout for all search requests
    actionAutoCreateIndex string
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    actionDestructiveRequiresName boolean
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    clusterBlocksReadOnly boolean
    Make the whole cluster read only and metadata is not allowed to be modified
    clusterBlocksReadOnlyAllowDelete boolean
    Make the whole cluster read only, but allows to delete indices to free up resources
    clusterIndicesCloseEnable boolean
    If false, you cannot close open indices
    clusterInfoUpdateInterval string
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    clusterMaxShardsPerNode number
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    clusterMaxShardsPerNodeFrozen number
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    clusterNoMasterBlock string
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    clusterPersistentTasksAllocationEnable string
    Whether allocation for persistent tasks is active (all, none)
    clusterPersistentTasksAllocationRecheckInterval string
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    clusterRoutingAllocationAllowRebalance string
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    clusterRoutingAllocationAwarenessAttributes string
    Use custom node attributes to take hardware configuration into account when allocating shards
    clusterRoutingAllocationAwarenessForceZoneValues string[]
    A list of zones for awareness allocation.
    clusterRoutingAllocationBalanceIndex number
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    clusterRoutingAllocationBalanceShard number
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    clusterRoutingAllocationBalanceThreshold number
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    clusterRoutingAllocationClusterConcurrentRebalance number
    How many concurrent shard rebalances are allowed cluster wide
    clusterRoutingAllocationDiskIncludeRelocations boolean
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    clusterRoutingAllocationDiskThresholdEnabled boolean
    Whether the disk allocation decider is active
    clusterRoutingAllocationDiskWatermarkHigh string
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    clusterRoutingAllocationDiskWatermarkLow string
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    clusterRoutingAllocationEnable string
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries number
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries number
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentRecoveries number
    A shortcut to set both incoming and outgoing recoveries
    clusterRoutingAllocationNodeInitialPrimariesRecoveries number
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    clusterRoutingAllocationSameShardHost boolean
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    clusterRoutingAllocationTotalShardsPerNode number
    Maximum number of primary and replica shards allocated to each node
    clusterRoutingRebalanceEnable string
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    clusterSearchRequestSlowlogLevel string
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    clusterSearchRequestSlowlogThresholdDebug string
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    clusterSearchRequestSlowlogThresholdInfo string
    Slowlog threshold for INFO level search requests (e.g., 5s)
    clusterSearchRequestSlowlogThresholdTrace string
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    clusterSearchRequestSlowlogThresholdWarn string
    Slowlog threshold for WARN level search requests (e.g., 10s)
    clusterSettingsId string
    The ID of this resource.
    indicesBreakerFielddataLimit string
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indicesBreakerFielddataOverhead number
    A constant that all field data estimations are multiplied by
    indicesBreakerRequestLimit string
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indicesBreakerRequestOverhead number
    A constant that all request estimations are multiplied by
    indicesBreakerTotalLimit string
    The percentage of total amount of memory that can be used across all breakers
    indicesRecoveryMaxBytesPerSec string
    Maximum total inbound and outbound recovery traffic for each node, in mb
    networkBreakerInflightRequestsLimit string
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    networkBreakerInflightRequestsOverhead number
    A constant that all in flight requests estimations are multiplied by
    scriptMaxCompilationsRate string
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    searchDefaultSearchTimeout string
    A time string setting a cluster-wide default timeout for all search requests
    action_auto_create_index str
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    action_destructive_requires_name bool
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    cluster_blocks_read_only bool
    Make the whole cluster read only and metadata is not allowed to be modified
    cluster_blocks_read_only_allow_delete bool
    Make the whole cluster read only, but allows to delete indices to free up resources
    cluster_indices_close_enable bool
    If false, you cannot close open indices
    cluster_info_update_interval str
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    cluster_max_shards_per_node float
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    cluster_max_shards_per_node_frozen float
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    cluster_no_master_block str
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    cluster_persistent_tasks_allocation_enable str
    Whether allocation for persistent tasks is active (all, none)
    cluster_persistent_tasks_allocation_recheck_interval str
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    cluster_routing_allocation_allow_rebalance str
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    cluster_routing_allocation_awareness_attributes str
    Use custom node attributes to take hardware configuration into account when allocating shards
    cluster_routing_allocation_awareness_force_zone_values Sequence[str]
    A list of zones for awareness allocation.
    cluster_routing_allocation_balance_index float
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    cluster_routing_allocation_balance_shard float
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    cluster_routing_allocation_balance_threshold float
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    cluster_routing_allocation_cluster_concurrent_rebalance float
    How many concurrent shard rebalances are allowed cluster wide
    cluster_routing_allocation_disk_include_relocations bool
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    cluster_routing_allocation_disk_threshold_enabled bool
    Whether the disk allocation decider is active
    cluster_routing_allocation_disk_watermark_high str
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    cluster_routing_allocation_disk_watermark_low str
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    cluster_routing_allocation_enable str
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    cluster_routing_allocation_node_concurrent_incoming_recoveries float
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    cluster_routing_allocation_node_concurrent_outgoing_recoveries float
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    cluster_routing_allocation_node_concurrent_recoveries float
    A shortcut to set both incoming and outgoing recoveries
    cluster_routing_allocation_node_initial_primaries_recoveries float
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    cluster_routing_allocation_same_shard_host bool
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    cluster_routing_allocation_total_shards_per_node float
    Maximum number of primary and replica shards allocated to each node
    cluster_routing_rebalance_enable str
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    cluster_search_request_slowlog_level str
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    cluster_search_request_slowlog_threshold_debug str
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    cluster_search_request_slowlog_threshold_info str
    Slowlog threshold for INFO level search requests (e.g., 5s)
    cluster_search_request_slowlog_threshold_trace str
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    cluster_search_request_slowlog_threshold_warn str
    Slowlog threshold for WARN level search requests (e.g., 10s)
    cluster_settings_id str
    The ID of this resource.
    indices_breaker_fielddata_limit str
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indices_breaker_fielddata_overhead float
    A constant that all field data estimations are multiplied by
    indices_breaker_request_limit str
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indices_breaker_request_overhead float
    A constant that all request estimations are multiplied by
    indices_breaker_total_limit str
    The percentage of total amount of memory that can be used across all breakers
    indices_recovery_max_bytes_per_sec str
    Maximum total inbound and outbound recovery traffic for each node, in mb
    network_breaker_inflight_requests_limit str
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    network_breaker_inflight_requests_overhead float
    A constant that all in flight requests estimations are multiplied by
    script_max_compilations_rate str
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    search_default_search_timeout str
    A time string setting a cluster-wide default timeout for all search requests
    actionAutoCreateIndex String
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    actionDestructiveRequiresName Boolean
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    clusterBlocksReadOnly Boolean
    Make the whole cluster read only and metadata is not allowed to be modified
    clusterBlocksReadOnlyAllowDelete Boolean
    Make the whole cluster read only, but allows to delete indices to free up resources
    clusterIndicesCloseEnable Boolean
    If false, you cannot close open indices
    clusterInfoUpdateInterval String
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    clusterMaxShardsPerNode Number
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    clusterMaxShardsPerNodeFrozen Number
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    clusterNoMasterBlock String
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    clusterPersistentTasksAllocationEnable String
    Whether allocation for persistent tasks is active (all, none)
    clusterPersistentTasksAllocationRecheckInterval String
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    clusterRoutingAllocationAllowRebalance String
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    clusterRoutingAllocationAwarenessAttributes String
    Use custom node attributes to take hardware configuration into account when allocating shards
    clusterRoutingAllocationAwarenessForceZoneValues List<String>
    A list of zones for awareness allocation.
    clusterRoutingAllocationBalanceIndex Number
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    clusterRoutingAllocationBalanceShard Number
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    clusterRoutingAllocationBalanceThreshold Number
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    clusterRoutingAllocationClusterConcurrentRebalance Number
    How many concurrent shard rebalances are allowed cluster wide
    clusterRoutingAllocationDiskIncludeRelocations Boolean
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    clusterRoutingAllocationDiskThresholdEnabled Boolean
    Whether the disk allocation decider is active
    clusterRoutingAllocationDiskWatermarkHigh String
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    clusterRoutingAllocationDiskWatermarkLow String
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    clusterRoutingAllocationEnable String
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries Number
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries Number
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentRecoveries Number
    A shortcut to set both incoming and outgoing recoveries
    clusterRoutingAllocationNodeInitialPrimariesRecoveries Number
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    clusterRoutingAllocationSameShardHost Boolean
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    clusterRoutingAllocationTotalShardsPerNode Number
    Maximum number of primary and replica shards allocated to each node
    clusterRoutingRebalanceEnable String
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    clusterSearchRequestSlowlogLevel String
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    clusterSearchRequestSlowlogThresholdDebug String
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    clusterSearchRequestSlowlogThresholdInfo String
    Slowlog threshold for INFO level search requests (e.g., 5s)
    clusterSearchRequestSlowlogThresholdTrace String
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    clusterSearchRequestSlowlogThresholdWarn String
    Slowlog threshold for WARN level search requests (e.g., 10s)
    clusterSettingsId String
    The ID of this resource.
    indicesBreakerFielddataLimit String
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indicesBreakerFielddataOverhead Number
    A constant that all field data estimations are multiplied by
    indicesBreakerRequestLimit String
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indicesBreakerRequestOverhead Number
    A constant that all request estimations are multiplied by
    indicesBreakerTotalLimit String
    The percentage of total amount of memory that can be used across all breakers
    indicesRecoveryMaxBytesPerSec String
    Maximum total inbound and outbound recovery traffic for each node, in mb
    networkBreakerInflightRequestsLimit String
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    networkBreakerInflightRequestsOverhead Number
    A constant that all in flight requests estimations are multiplied by
    scriptMaxCompilationsRate String
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    searchDefaultSearchTimeout String
    A time string setting a cluster-wide default timeout for all search requests

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClusterSettings 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 ClusterSettings Resource

    Get an existing ClusterSettings 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?: ClusterSettingsState, opts?: CustomResourceOptions): ClusterSettings
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        action_auto_create_index: Optional[str] = None,
        action_destructive_requires_name: Optional[bool] = None,
        cluster_blocks_read_only: Optional[bool] = None,
        cluster_blocks_read_only_allow_delete: Optional[bool] = None,
        cluster_indices_close_enable: Optional[bool] = None,
        cluster_info_update_interval: Optional[str] = None,
        cluster_max_shards_per_node: Optional[float] = None,
        cluster_max_shards_per_node_frozen: Optional[float] = None,
        cluster_no_master_block: Optional[str] = None,
        cluster_persistent_tasks_allocation_enable: Optional[str] = None,
        cluster_persistent_tasks_allocation_recheck_interval: Optional[str] = None,
        cluster_routing_allocation_allow_rebalance: Optional[str] = None,
        cluster_routing_allocation_awareness_attributes: Optional[str] = None,
        cluster_routing_allocation_awareness_force_zone_values: Optional[Sequence[str]] = None,
        cluster_routing_allocation_balance_index: Optional[float] = None,
        cluster_routing_allocation_balance_shard: Optional[float] = None,
        cluster_routing_allocation_balance_threshold: Optional[float] = None,
        cluster_routing_allocation_cluster_concurrent_rebalance: Optional[float] = None,
        cluster_routing_allocation_disk_include_relocations: Optional[bool] = None,
        cluster_routing_allocation_disk_threshold_enabled: Optional[bool] = None,
        cluster_routing_allocation_disk_watermark_high: Optional[str] = None,
        cluster_routing_allocation_disk_watermark_low: Optional[str] = None,
        cluster_routing_allocation_enable: Optional[str] = None,
        cluster_routing_allocation_node_concurrent_incoming_recoveries: Optional[float] = None,
        cluster_routing_allocation_node_concurrent_outgoing_recoveries: Optional[float] = None,
        cluster_routing_allocation_node_concurrent_recoveries: Optional[float] = None,
        cluster_routing_allocation_node_initial_primaries_recoveries: Optional[float] = None,
        cluster_routing_allocation_same_shard_host: Optional[bool] = None,
        cluster_routing_allocation_total_shards_per_node: Optional[float] = None,
        cluster_routing_rebalance_enable: Optional[str] = None,
        cluster_search_request_slowlog_level: Optional[str] = None,
        cluster_search_request_slowlog_threshold_debug: Optional[str] = None,
        cluster_search_request_slowlog_threshold_info: Optional[str] = None,
        cluster_search_request_slowlog_threshold_trace: Optional[str] = None,
        cluster_search_request_slowlog_threshold_warn: Optional[str] = None,
        cluster_settings_id: Optional[str] = None,
        indices_breaker_fielddata_limit: Optional[str] = None,
        indices_breaker_fielddata_overhead: Optional[float] = None,
        indices_breaker_request_limit: Optional[str] = None,
        indices_breaker_request_overhead: Optional[float] = None,
        indices_breaker_total_limit: Optional[str] = None,
        indices_recovery_max_bytes_per_sec: Optional[str] = None,
        network_breaker_inflight_requests_limit: Optional[str] = None,
        network_breaker_inflight_requests_overhead: Optional[float] = None,
        script_max_compilations_rate: Optional[str] = None,
        search_default_search_timeout: Optional[str] = None) -> ClusterSettings
    func GetClusterSettings(ctx *Context, name string, id IDInput, state *ClusterSettingsState, opts ...ResourceOption) (*ClusterSettings, error)
    public static ClusterSettings Get(string name, Input<string> id, ClusterSettingsState? state, CustomResourceOptions? opts = null)
    public static ClusterSettings get(String name, Output<String> id, ClusterSettingsState state, CustomResourceOptions options)
    resources:  _:    type: opensearch:ClusterSettings    get:      id: ${id}
    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.
    The following state arguments are supported:
    ActionAutoCreateIndex string
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    ActionDestructiveRequiresName bool
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    ClusterBlocksReadOnly bool
    Make the whole cluster read only and metadata is not allowed to be modified
    ClusterBlocksReadOnlyAllowDelete bool
    Make the whole cluster read only, but allows to delete indices to free up resources
    ClusterIndicesCloseEnable bool
    If false, you cannot close open indices
    ClusterInfoUpdateInterval string
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    ClusterMaxShardsPerNode double
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    ClusterMaxShardsPerNodeFrozen double
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    ClusterNoMasterBlock string
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    ClusterPersistentTasksAllocationEnable string
    Whether allocation for persistent tasks is active (all, none)
    ClusterPersistentTasksAllocationRecheckInterval string
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    ClusterRoutingAllocationAllowRebalance string
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    ClusterRoutingAllocationAwarenessAttributes string
    Use custom node attributes to take hardware configuration into account when allocating shards
    ClusterRoutingAllocationAwarenessForceZoneValues List<string>
    A list of zones for awareness allocation.
    ClusterRoutingAllocationBalanceIndex double
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    ClusterRoutingAllocationBalanceShard double
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    ClusterRoutingAllocationBalanceThreshold double
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    ClusterRoutingAllocationClusterConcurrentRebalance double
    How many concurrent shard rebalances are allowed cluster wide
    ClusterRoutingAllocationDiskIncludeRelocations bool
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    ClusterRoutingAllocationDiskThresholdEnabled bool
    Whether the disk allocation decider is active
    ClusterRoutingAllocationDiskWatermarkHigh string
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    ClusterRoutingAllocationDiskWatermarkLow string
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    ClusterRoutingAllocationEnable string
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    ClusterRoutingAllocationNodeConcurrentIncomingRecoveries double
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentOutgoingRecoveries double
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentRecoveries double
    A shortcut to set both incoming and outgoing recoveries
    ClusterRoutingAllocationNodeInitialPrimariesRecoveries double
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    ClusterRoutingAllocationSameShardHost bool
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    ClusterRoutingAllocationTotalShardsPerNode double
    Maximum number of primary and replica shards allocated to each node
    ClusterRoutingRebalanceEnable string
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    ClusterSearchRequestSlowlogLevel string
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    ClusterSearchRequestSlowlogThresholdDebug string
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    ClusterSearchRequestSlowlogThresholdInfo string
    Slowlog threshold for INFO level search requests (e.g., 5s)
    ClusterSearchRequestSlowlogThresholdTrace string
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    ClusterSearchRequestSlowlogThresholdWarn string
    Slowlog threshold for WARN level search requests (e.g., 10s)
    ClusterSettingsId string
    The ID of this resource.
    IndicesBreakerFielddataLimit string
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    IndicesBreakerFielddataOverhead double
    A constant that all field data estimations are multiplied by
    IndicesBreakerRequestLimit string
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    IndicesBreakerRequestOverhead double
    A constant that all request estimations are multiplied by
    IndicesBreakerTotalLimit string
    The percentage of total amount of memory that can be used across all breakers
    IndicesRecoveryMaxBytesPerSec string
    Maximum total inbound and outbound recovery traffic for each node, in mb
    NetworkBreakerInflightRequestsLimit string
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    NetworkBreakerInflightRequestsOverhead double
    A constant that all in flight requests estimations are multiplied by
    ScriptMaxCompilationsRate string
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    SearchDefaultSearchTimeout string
    A time string setting a cluster-wide default timeout for all search requests
    ActionAutoCreateIndex string
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    ActionDestructiveRequiresName bool
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    ClusterBlocksReadOnly bool
    Make the whole cluster read only and metadata is not allowed to be modified
    ClusterBlocksReadOnlyAllowDelete bool
    Make the whole cluster read only, but allows to delete indices to free up resources
    ClusterIndicesCloseEnable bool
    If false, you cannot close open indices
    ClusterInfoUpdateInterval string
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    ClusterMaxShardsPerNode float64
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    ClusterMaxShardsPerNodeFrozen float64
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    ClusterNoMasterBlock string
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    ClusterPersistentTasksAllocationEnable string
    Whether allocation for persistent tasks is active (all, none)
    ClusterPersistentTasksAllocationRecheckInterval string
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    ClusterRoutingAllocationAllowRebalance string
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    ClusterRoutingAllocationAwarenessAttributes string
    Use custom node attributes to take hardware configuration into account when allocating shards
    ClusterRoutingAllocationAwarenessForceZoneValues []string
    A list of zones for awareness allocation.
    ClusterRoutingAllocationBalanceIndex float64
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    ClusterRoutingAllocationBalanceShard float64
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    ClusterRoutingAllocationBalanceThreshold float64
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    ClusterRoutingAllocationClusterConcurrentRebalance float64
    How many concurrent shard rebalances are allowed cluster wide
    ClusterRoutingAllocationDiskIncludeRelocations bool
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    ClusterRoutingAllocationDiskThresholdEnabled bool
    Whether the disk allocation decider is active
    ClusterRoutingAllocationDiskWatermarkHigh string
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    ClusterRoutingAllocationDiskWatermarkLow string
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    ClusterRoutingAllocationEnable string
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    ClusterRoutingAllocationNodeConcurrentIncomingRecoveries float64
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentOutgoingRecoveries float64
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    ClusterRoutingAllocationNodeConcurrentRecoveries float64
    A shortcut to set both incoming and outgoing recoveries
    ClusterRoutingAllocationNodeInitialPrimariesRecoveries float64
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    ClusterRoutingAllocationSameShardHost bool
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    ClusterRoutingAllocationTotalShardsPerNode float64
    Maximum number of primary and replica shards allocated to each node
    ClusterRoutingRebalanceEnable string
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    ClusterSearchRequestSlowlogLevel string
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    ClusterSearchRequestSlowlogThresholdDebug string
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    ClusterSearchRequestSlowlogThresholdInfo string
    Slowlog threshold for INFO level search requests (e.g., 5s)
    ClusterSearchRequestSlowlogThresholdTrace string
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    ClusterSearchRequestSlowlogThresholdWarn string
    Slowlog threshold for WARN level search requests (e.g., 10s)
    ClusterSettingsId string
    The ID of this resource.
    IndicesBreakerFielddataLimit string
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    IndicesBreakerFielddataOverhead float64
    A constant that all field data estimations are multiplied by
    IndicesBreakerRequestLimit string
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    IndicesBreakerRequestOverhead float64
    A constant that all request estimations are multiplied by
    IndicesBreakerTotalLimit string
    The percentage of total amount of memory that can be used across all breakers
    IndicesRecoveryMaxBytesPerSec string
    Maximum total inbound and outbound recovery traffic for each node, in mb
    NetworkBreakerInflightRequestsLimit string
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    NetworkBreakerInflightRequestsOverhead float64
    A constant that all in flight requests estimations are multiplied by
    ScriptMaxCompilationsRate string
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    SearchDefaultSearchTimeout string
    A time string setting a cluster-wide default timeout for all search requests
    actionAutoCreateIndex String
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    actionDestructiveRequiresName Boolean
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    clusterBlocksReadOnly Boolean
    Make the whole cluster read only and metadata is not allowed to be modified
    clusterBlocksReadOnlyAllowDelete Boolean
    Make the whole cluster read only, but allows to delete indices to free up resources
    clusterIndicesCloseEnable Boolean
    If false, you cannot close open indices
    clusterInfoUpdateInterval String
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    clusterMaxShardsPerNode Double
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    clusterMaxShardsPerNodeFrozen Double
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    clusterNoMasterBlock String
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    clusterPersistentTasksAllocationEnable String
    Whether allocation for persistent tasks is active (all, none)
    clusterPersistentTasksAllocationRecheckInterval String
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    clusterRoutingAllocationAllowRebalance String
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    clusterRoutingAllocationAwarenessAttributes String
    Use custom node attributes to take hardware configuration into account when allocating shards
    clusterRoutingAllocationAwarenessForceZoneValues List<String>
    A list of zones for awareness allocation.
    clusterRoutingAllocationBalanceIndex Double
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    clusterRoutingAllocationBalanceShard Double
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    clusterRoutingAllocationBalanceThreshold Double
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    clusterRoutingAllocationClusterConcurrentRebalance Double
    How many concurrent shard rebalances are allowed cluster wide
    clusterRoutingAllocationDiskIncludeRelocations Boolean
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    clusterRoutingAllocationDiskThresholdEnabled Boolean
    Whether the disk allocation decider is active
    clusterRoutingAllocationDiskWatermarkHigh String
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    clusterRoutingAllocationDiskWatermarkLow String
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    clusterRoutingAllocationEnable String
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries Double
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries Double
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentRecoveries Double
    A shortcut to set both incoming and outgoing recoveries
    clusterRoutingAllocationNodeInitialPrimariesRecoveries Double
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    clusterRoutingAllocationSameShardHost Boolean
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    clusterRoutingAllocationTotalShardsPerNode Double
    Maximum number of primary and replica shards allocated to each node
    clusterRoutingRebalanceEnable String
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    clusterSearchRequestSlowlogLevel String
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    clusterSearchRequestSlowlogThresholdDebug String
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    clusterSearchRequestSlowlogThresholdInfo String
    Slowlog threshold for INFO level search requests (e.g., 5s)
    clusterSearchRequestSlowlogThresholdTrace String
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    clusterSearchRequestSlowlogThresholdWarn String
    Slowlog threshold for WARN level search requests (e.g., 10s)
    clusterSettingsId String
    The ID of this resource.
    indicesBreakerFielddataLimit String
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indicesBreakerFielddataOverhead Double
    A constant that all field data estimations are multiplied by
    indicesBreakerRequestLimit String
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indicesBreakerRequestOverhead Double
    A constant that all request estimations are multiplied by
    indicesBreakerTotalLimit String
    The percentage of total amount of memory that can be used across all breakers
    indicesRecoveryMaxBytesPerSec String
    Maximum total inbound and outbound recovery traffic for each node, in mb
    networkBreakerInflightRequestsLimit String
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    networkBreakerInflightRequestsOverhead Double
    A constant that all in flight requests estimations are multiplied by
    scriptMaxCompilationsRate String
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    searchDefaultSearchTimeout String
    A time string setting a cluster-wide default timeout for all search requests
    actionAutoCreateIndex string
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    actionDestructiveRequiresName boolean
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    clusterBlocksReadOnly boolean
    Make the whole cluster read only and metadata is not allowed to be modified
    clusterBlocksReadOnlyAllowDelete boolean
    Make the whole cluster read only, but allows to delete indices to free up resources
    clusterIndicesCloseEnable boolean
    If false, you cannot close open indices
    clusterInfoUpdateInterval string
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    clusterMaxShardsPerNode number
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    clusterMaxShardsPerNodeFrozen number
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    clusterNoMasterBlock string
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    clusterPersistentTasksAllocationEnable string
    Whether allocation for persistent tasks is active (all, none)
    clusterPersistentTasksAllocationRecheckInterval string
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    clusterRoutingAllocationAllowRebalance string
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    clusterRoutingAllocationAwarenessAttributes string
    Use custom node attributes to take hardware configuration into account when allocating shards
    clusterRoutingAllocationAwarenessForceZoneValues string[]
    A list of zones for awareness allocation.
    clusterRoutingAllocationBalanceIndex number
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    clusterRoutingAllocationBalanceShard number
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    clusterRoutingAllocationBalanceThreshold number
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    clusterRoutingAllocationClusterConcurrentRebalance number
    How many concurrent shard rebalances are allowed cluster wide
    clusterRoutingAllocationDiskIncludeRelocations boolean
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    clusterRoutingAllocationDiskThresholdEnabled boolean
    Whether the disk allocation decider is active
    clusterRoutingAllocationDiskWatermarkHigh string
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    clusterRoutingAllocationDiskWatermarkLow string
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    clusterRoutingAllocationEnable string
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries number
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries number
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentRecoveries number
    A shortcut to set both incoming and outgoing recoveries
    clusterRoutingAllocationNodeInitialPrimariesRecoveries number
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    clusterRoutingAllocationSameShardHost boolean
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    clusterRoutingAllocationTotalShardsPerNode number
    Maximum number of primary and replica shards allocated to each node
    clusterRoutingRebalanceEnable string
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    clusterSearchRequestSlowlogLevel string
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    clusterSearchRequestSlowlogThresholdDebug string
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    clusterSearchRequestSlowlogThresholdInfo string
    Slowlog threshold for INFO level search requests (e.g., 5s)
    clusterSearchRequestSlowlogThresholdTrace string
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    clusterSearchRequestSlowlogThresholdWarn string
    Slowlog threshold for WARN level search requests (e.g., 10s)
    clusterSettingsId string
    The ID of this resource.
    indicesBreakerFielddataLimit string
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indicesBreakerFielddataOverhead number
    A constant that all field data estimations are multiplied by
    indicesBreakerRequestLimit string
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indicesBreakerRequestOverhead number
    A constant that all request estimations are multiplied by
    indicesBreakerTotalLimit string
    The percentage of total amount of memory that can be used across all breakers
    indicesRecoveryMaxBytesPerSec string
    Maximum total inbound and outbound recovery traffic for each node, in mb
    networkBreakerInflightRequestsLimit string
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    networkBreakerInflightRequestsOverhead number
    A constant that all in flight requests estimations are multiplied by
    scriptMaxCompilationsRate string
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    searchDefaultSearchTimeout string
    A time string setting a cluster-wide default timeout for all search requests
    action_auto_create_index str
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    action_destructive_requires_name bool
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    cluster_blocks_read_only bool
    Make the whole cluster read only and metadata is not allowed to be modified
    cluster_blocks_read_only_allow_delete bool
    Make the whole cluster read only, but allows to delete indices to free up resources
    cluster_indices_close_enable bool
    If false, you cannot close open indices
    cluster_info_update_interval str
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    cluster_max_shards_per_node float
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    cluster_max_shards_per_node_frozen float
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    cluster_no_master_block str
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    cluster_persistent_tasks_allocation_enable str
    Whether allocation for persistent tasks is active (all, none)
    cluster_persistent_tasks_allocation_recheck_interval str
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    cluster_routing_allocation_allow_rebalance str
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    cluster_routing_allocation_awareness_attributes str
    Use custom node attributes to take hardware configuration into account when allocating shards
    cluster_routing_allocation_awareness_force_zone_values Sequence[str]
    A list of zones for awareness allocation.
    cluster_routing_allocation_balance_index float
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    cluster_routing_allocation_balance_shard float
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    cluster_routing_allocation_balance_threshold float
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    cluster_routing_allocation_cluster_concurrent_rebalance float
    How many concurrent shard rebalances are allowed cluster wide
    cluster_routing_allocation_disk_include_relocations bool
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    cluster_routing_allocation_disk_threshold_enabled bool
    Whether the disk allocation decider is active
    cluster_routing_allocation_disk_watermark_high str
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    cluster_routing_allocation_disk_watermark_low str
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    cluster_routing_allocation_enable str
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    cluster_routing_allocation_node_concurrent_incoming_recoveries float
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    cluster_routing_allocation_node_concurrent_outgoing_recoveries float
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    cluster_routing_allocation_node_concurrent_recoveries float
    A shortcut to set both incoming and outgoing recoveries
    cluster_routing_allocation_node_initial_primaries_recoveries float
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    cluster_routing_allocation_same_shard_host bool
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    cluster_routing_allocation_total_shards_per_node float
    Maximum number of primary and replica shards allocated to each node
    cluster_routing_rebalance_enable str
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    cluster_search_request_slowlog_level str
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    cluster_search_request_slowlog_threshold_debug str
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    cluster_search_request_slowlog_threshold_info str
    Slowlog threshold for INFO level search requests (e.g., 5s)
    cluster_search_request_slowlog_threshold_trace str
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    cluster_search_request_slowlog_threshold_warn str
    Slowlog threshold for WARN level search requests (e.g., 10s)
    cluster_settings_id str
    The ID of this resource.
    indices_breaker_fielddata_limit str
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indices_breaker_fielddata_overhead float
    A constant that all field data estimations are multiplied by
    indices_breaker_request_limit str
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indices_breaker_request_overhead float
    A constant that all request estimations are multiplied by
    indices_breaker_total_limit str
    The percentage of total amount of memory that can be used across all breakers
    indices_recovery_max_bytes_per_sec str
    Maximum total inbound and outbound recovery traffic for each node, in mb
    network_breaker_inflight_requests_limit str
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    network_breaker_inflight_requests_overhead float
    A constant that all in flight requests estimations are multiplied by
    script_max_compilations_rate str
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    search_default_search_timeout str
    A time string setting a cluster-wide default timeout for all search requests
    actionAutoCreateIndex String
    Whether to automatically create an index if it doesn’t already exist and apply any configured index template
    actionDestructiveRequiresName Boolean
    When set to true, you must specify the index name to delete an index and it is not possible to delete all indices with _all or use wildcards
    clusterBlocksReadOnly Boolean
    Make the whole cluster read only and metadata is not allowed to be modified
    clusterBlocksReadOnlyAllowDelete Boolean
    Make the whole cluster read only, but allows to delete indices to free up resources
    clusterIndicesCloseEnable Boolean
    If false, you cannot close open indices
    clusterInfoUpdateInterval String
    A time string controlling how often OpenSearch should check on disk usage for each node in the cluster
    clusterMaxShardsPerNode Number
    The total number of primary and replica shards for the cluster, this number is multiplied by the number of non-frozen data nodes; shards for closed indices do not count toward this limit
    clusterMaxShardsPerNodeFrozen Number
    The total number of primary and replica frozen shards, for the cluster; Ssards for closed indices do not count toward this limit, a cluster with no frozen data nodes is unlimited.
    clusterNoMasterBlock String
    Specifies which operations are rejected when there is no active master in a cluster (all, write)
    clusterPersistentTasksAllocationEnable String
    Whether allocation for persistent tasks is active (all, none)
    clusterPersistentTasksAllocationRecheckInterval String
    A time string controling how often assignment checks are performed to react to whether persistent tasks can be assigned to nodes
    clusterRoutingAllocationAllowRebalance String
    Specify when shard rebalancing is allowed (always, indicesprimariesactive, indicesallactive)
    clusterRoutingAllocationAwarenessAttributes String
    Use custom node attributes to take hardware configuration into account when allocating shards
    clusterRoutingAllocationAwarenessForceZoneValues List<String>
    A list of zones for awareness allocation.
    clusterRoutingAllocationBalanceIndex Number
    Weight factor for the number of shards per index allocated on a node, increasing this raises the tendency to equalize the number of shards per index across all nodes
    clusterRoutingAllocationBalanceShard Number
    Weight factor for the total number of shards allocated on a node, increasing this raises the tendency to equalize the number of shards across all nodes
    clusterRoutingAllocationBalanceThreshold Number
    Minimal optimization value of operations that should be performed, raising this will cause the cluster to be less aggressive about optimizing the shard balance
    clusterRoutingAllocationClusterConcurrentRebalance Number
    How many concurrent shard rebalances are allowed cluster wide
    clusterRoutingAllocationDiskIncludeRelocations Boolean
    Whether the allocator will take into account shards that are currently being relocated to the target node when computing a node’s disk usage
    clusterRoutingAllocationDiskThresholdEnabled Boolean
    Whether the disk allocation decider is active
    clusterRoutingAllocationDiskWatermarkHigh String
    Allocator will attempt to relocate shards away from a node whose disk usage is above this percentage disk used
    clusterRoutingAllocationDiskWatermarkLow String
    Allocator will not allocate shards to nodes that have more than this percentage disk used
    clusterRoutingAllocationEnable String
    Enable or disable allocation for specific kinds of shards (all, primaries, new_primaries, none)
    clusterRoutingAllocationNodeConcurrentIncomingRecoveries Number
    How many incoming recoveries where the target shard (likely the replica unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentOutgoingRecoveries Number
    How many outgoing recoveries where the source shard (likely the primary unless a shard is relocating) are allocated on the node
    clusterRoutingAllocationNodeConcurrentRecoveries Number
    A shortcut to set both incoming and outgoing recoveries
    clusterRoutingAllocationNodeInitialPrimariesRecoveries Number
    Set a (usually) higher rate for primary recovery on node restart (usually from disk, so fast)
    clusterRoutingAllocationSameShardHost Boolean
    Perform a check to prevent allocation of multiple instances of the same shard on a single host, if multiple nodes are started on the host
    clusterRoutingAllocationTotalShardsPerNode Number
    Maximum number of primary and replica shards allocated to each node
    clusterRoutingRebalanceEnable String
    Allow rebalancing for specific kinds of shards (all, primaries, replicas, none)
    clusterSearchRequestSlowlogLevel String
    Log level for search requests slowlog (TRACE, DEBUG, INFO, WARN)
    clusterSearchRequestSlowlogThresholdDebug String
    Slowlog threshold for DEBUG level search requests (e.g., 2s)
    clusterSearchRequestSlowlogThresholdInfo String
    Slowlog threshold for INFO level search requests (e.g., 5s)
    clusterSearchRequestSlowlogThresholdTrace String
    Slowlog threshold for TRACE level search requests (e.g., 10ms)
    clusterSearchRequestSlowlogThresholdWarn String
    Slowlog threshold for WARN level search requests (e.g., 10s)
    clusterSettingsId String
    The ID of this resource.
    indicesBreakerFielddataLimit String
    The percentage of memory above which if loading a field into the field data cache would cause the cache to exceed this limit, an error is returned
    indicesBreakerFielddataOverhead Number
    A constant that all field data estimations are multiplied by
    indicesBreakerRequestLimit String
    The percentabge of memory above which per-request data structures (e.g. calculating aggregations) are prevented from exceeding
    indicesBreakerRequestOverhead Number
    A constant that all request estimations are multiplied by
    indicesBreakerTotalLimit String
    The percentage of total amount of memory that can be used across all breakers
    indicesRecoveryMaxBytesPerSec String
    Maximum total inbound and outbound recovery traffic for each node, in mb
    networkBreakerInflightRequestsLimit String
    The percentage limit of memory usage on a node of all currently active incoming requests on transport or HTTP level
    networkBreakerInflightRequestsOverhead Number
    A constant that all in flight requests estimations are multiplied by
    scriptMaxCompilationsRate String
    Limit for the number of unique dynamic scripts within a certain interval that are allowed to be compiled, expressed as compilations divided by a time string
    searchDefaultSearchTimeout String
    A time string setting a cluster-wide default timeout for all search requests

    Package Details

    Repository
    opensearch opensearch-project/terraform-provider-opensearch
    License
    Notes
    This Pulumi package is based on the opensearch Terraform Provider.
    opensearch logo
    opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project
    opensearch-project/terraform-provider-opensearch