Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Elasticstack Provider
  4. API Docs
  5. getElasticsearchQueryRuleset
Viewing docs for elasticstack 0.16.1
published on Monday, Jun 1, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

elasticstack.getElasticsearchQueryRuleset

Viewing docs for elasticstack 0.16.1
published on Monday, Jun 1, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

    Reads an Elasticsearch query ruleset by ruleset_id. See the Query Rules API documentation for more details.

    Example Usage

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

const myRuleset = new elasticstack.ElasticsearchQueryRuleset("my_ruleset", {
    rulesetId: "my-search-rules",
    rules: [
        {
            ruleId: "pin-laptops",
            type: "pinned",
            priority: 1,
            criterias: [{
                type: "exact",
                metadata: "query",
                values: JSON.stringify([
                    "laptop",
                    "notebook",
                ]),
            }],
            actions: {
                ids: [
                    "doc-1",
                    "doc-2",
                ],
            },
        },
        {
            ruleId: "exclude-deprecated",
            type: "exclude",
            criterias: [{
                type: "contains",
                metadata: "query",
                values: JSON.stringify(["deprecated"]),
            }],
            actions: {
                docs: [{
                    _index: "products",
                    _id: "old-1",
                }],
            },
        },
    ],
});
const example = elasticstack.getElasticsearchQueryRulesetOutput({
    rulesetId: myRuleset.rulesetId,
});
export const rules = example.apply(example => example.rules);

    import pulumi
import json
import pulumi_elasticstack as elasticstack

my_ruleset = elasticstack.ElasticsearchQueryRuleset("my_ruleset",
    ruleset_id="my-search-rules",
    rules=[
        {
            "rule_id": "pin-laptops",
            "type": "pinned",
            "priority": 1,
            "criterias": [{
                "type": "exact",
                "metadata": "query",
                "values": json.dumps([
                    "laptop",
                    "notebook",
                ]),
            }],
            "actions": {
                "ids": [
                    "doc-1",
                    "doc-2",
                ],
            },
        },
        {
            "rule_id": "exclude-deprecated",
            "type": "exclude",
            "criterias": [{
                "type": "contains",
                "metadata": "query",
                "values": json.dumps(["deprecated"]),
            }],
            "actions": {
                "docs": [{
                    "_index": "products",
                    "_id": "old-1",
                }],
            },
        },
    ])
example = elasticstack.get_elasticsearch_query_ruleset_output(ruleset_id=my_ruleset.ruleset_id)
pulumi.export("rules", example.rules)

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-terraform-provider/sdks/go/elasticstack/elasticstack"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal([]string{
			"laptop",
			"notebook",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal([]string{
			"deprecated",
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		myRuleset, err := elasticstack.NewElasticsearchQueryRuleset(ctx, "my_ruleset", &elasticstack.ElasticsearchQueryRulesetArgs{
			RulesetId: pulumi.String("my-search-rules"),
			Rules: elasticstack.ElasticsearchQueryRulesetRuleArray{
				&elasticstack.ElasticsearchQueryRulesetRuleArgs{
					RuleId:   pulumi.String("pin-laptops"),
					Type:     pulumi.String("pinned"),
					Priority: pulumi.Float64(1),
					Criterias: elasticstack.ElasticsearchQueryRulesetRuleCriteriaArray{
						&elasticstack.ElasticsearchQueryRulesetRuleCriteriaArgs{
							Type:     pulumi.String("exact"),
							Metadata: pulumi.String("query"),
							Values:   pulumi.String(json0),
						},
					},
					Actions: &elasticstack.ElasticsearchQueryRulesetRuleActionsArgs{
						Ids: pulumi.StringArray{
							pulumi.String("doc-1"),
							pulumi.String("doc-2"),
						},
					},
				},
				&elasticstack.ElasticsearchQueryRulesetRuleArgs{
					RuleId: pulumi.String("exclude-deprecated"),
					Type:   pulumi.String("exclude"),
					Criterias: elasticstack.ElasticsearchQueryRulesetRuleCriteriaArray{
						&elasticstack.ElasticsearchQueryRulesetRuleCriteriaArgs{
							Type:     pulumi.String("contains"),
							Metadata: pulumi.String("query"),
							Values:   pulumi.String(json1),
						},
					},
					Actions: &elasticstack.ElasticsearchQueryRulesetRuleActionsArgs{
						Docs: elasticstack.ElasticsearchQueryRulesetRuleActionsDocArray{
							&elasticstack.ElasticsearchQueryRulesetRuleActionsDocArgs{
								_index: pulumi.String("products"),
								_id:    pulumi.String("old-1"),
							},
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		example := elasticstack.LookupElasticsearchQueryRulesetOutput(ctx, elasticstack.GetElasticsearchQueryRulesetOutputArgs{
			RulesetId: myRuleset.RulesetId,
		}, nil)
		ctx.Export("rules", example.ApplyT(func(example elasticstack.GetElasticsearchQueryRulesetResult) ([]elasticstack.GetElasticsearchQueryRulesetRule, error) {
			return []elasticstack.GetElasticsearchQueryRulesetRule(example.Rules), nil
		}).([]elasticstack.GetElasticsearchQueryRulesetRuleOutput))
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var myRuleset = new Elasticstack.ElasticsearchQueryRuleset("my_ruleset", new()
    {
        RulesetId = "my-search-rules",
        Rules = new[]
        {
            new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleArgs
            {
                RuleId = "pin-laptops",
                Type = "pinned",
                Priority = 1,
                Criterias = new[]
                {
                    new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleCriteriaArgs
                    {
                        Type = "exact",
                        Metadata = "query",
                        Values = JsonSerializer.Serialize(new[]
                        {
                            "laptop",
                            "notebook",
                        }),
                    },
                },
                Actions = new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleActionsArgs
                {
                    Ids = new[]
                    {
                        "doc-1",
                        "doc-2",
                    },
                },
            },
            new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleArgs
            {
                RuleId = "exclude-deprecated",
                Type = "exclude",
                Criterias = new[]
                {
                    new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleCriteriaArgs
                    {
                        Type = "contains",
                        Metadata = "query",
                        Values = JsonSerializer.Serialize(new[]
                        {
                            "deprecated",
                        }),
                    },
                },
                Actions = new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleActionsArgs
                {
                    Docs = new[]
                    {
                        new Elasticstack.Inputs.ElasticsearchQueryRulesetRuleActionsDocArgs
                        {
                            _index = "products",
                            _id = "old-1",
                        },
                    },
                },
            },
        },
    });

    var example = Elasticstack.GetElasticsearchQueryRuleset.Invoke(new()
    {
        RulesetId = myRuleset.RulesetId,
    });

    return new Dictionary<string, object?>
    {
        ["rules"] = example.Apply(getElasticsearchQueryRulesetResult => getElasticsearchQueryRulesetResult.Rules),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticsearchQueryRuleset;
import com.pulumi.elasticstack.ElasticsearchQueryRulesetArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchQueryRulesetRuleArgs;
import com.pulumi.elasticstack.inputs.ElasticsearchQueryRulesetRuleActionsArgs;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetElasticsearchQueryRulesetArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 myRuleset = new ElasticsearchQueryRuleset("myRuleset", ElasticsearchQueryRulesetArgs.builder()
            .rulesetId("my-search-rules")
            .rules(            
                ElasticsearchQueryRulesetRuleArgs.builder()
                    .ruleId("pin-laptops")
                    .type("pinned")
                    .priority(1.0)
                    .criterias(ElasticsearchQueryRulesetRuleCriteriaArgs.builder()
                        .type("exact")
                        .metadata("query")
                        .values(serializeJson(
                            jsonArray(
                                "laptop", 
                                "notebook"
                            )))
                        .build())
                    .actions(ElasticsearchQueryRulesetRuleActionsArgs.builder()
                        .ids(                        
                            "doc-1",
                            "doc-2")
                        .build())
                    .build(),
                ElasticsearchQueryRulesetRuleArgs.builder()
                    .ruleId("exclude-deprecated")
                    .type("exclude")
                    .criterias(ElasticsearchQueryRulesetRuleCriteriaArgs.builder()
                        .type("contains")
                        .metadata("query")
                        .values(serializeJson(
                            jsonArray("deprecated")))
                        .build())
                    .actions(ElasticsearchQueryRulesetRuleActionsArgs.builder()
                        .docs(ElasticsearchQueryRulesetRuleActionsDocArgs.builder()
                            ._index("products")
                            ._id("old-1")
                            .build())
                        .build())
                    .build())
            .build());

        final var example = ElasticstackFunctions.getElasticsearchQueryRuleset(GetElasticsearchQueryRulesetArgs.builder()
            .rulesetId(myRuleset.rulesetId())
            .build());

        ctx.export("rules", example.applyValue(_example -> _example.rules()));
    }
}

    resources:
  myRuleset:
    type: elasticstack:ElasticsearchQueryRuleset
    name: my_ruleset
    properties:
      rulesetId: my-search-rules
      rules:
        - ruleId: pin-laptops
          type: pinned
          priority: 1
          criterias:
            - type: exact
              metadata: query
              values:
                fn::toJSON:
                  - laptop
                  - notebook
          actions:
            ids:
              - doc-1
              - doc-2
        - ruleId: exclude-deprecated
          type: exclude
          criterias:
            - type: contains
              metadata: query
              values:
                fn::toJSON:
                  - deprecated
          actions:
            docs:
              - _index: products
                _id: old-1
variables:
  example:
    fn::invoke:
      function: elasticstack:getElasticsearchQueryRuleset
      arguments:
        rulesetId: ${myRuleset.rulesetId}
outputs:
  rules: ${example.rules}

    Example coming soon!

    Using getElasticsearchQueryRuleset

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getElasticsearchQueryRuleset(args: GetElasticsearchQueryRulesetArgs, opts?: InvokeOptions): Promise<GetElasticsearchQueryRulesetResult>
function getElasticsearchQueryRulesetOutput(args: GetElasticsearchQueryRulesetOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchQueryRulesetResult>
    def get_elasticsearch_query_ruleset(elasticsearch_connections: Optional[Sequence[GetElasticsearchQueryRulesetElasticsearchConnection]] = None,
                                    ruleset_id: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetElasticsearchQueryRulesetResult
def get_elasticsearch_query_ruleset_output(elasticsearch_connections: pulumi.Input[Optional[Sequence[pulumi.Input[GetElasticsearchQueryRulesetElasticsearchConnectionArgs]]]] = None,
                                    ruleset_id: pulumi.Input[Optional[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchQueryRulesetResult]
    func LookupElasticsearchQueryRuleset(ctx *Context, args *LookupElasticsearchQueryRulesetArgs, opts ...InvokeOption) (*LookupElasticsearchQueryRulesetResult, error)
func LookupElasticsearchQueryRulesetOutput(ctx *Context, args *LookupElasticsearchQueryRulesetOutputArgs, opts ...InvokeOption) LookupElasticsearchQueryRulesetResultOutput

    > Note: This function is named LookupElasticsearchQueryRuleset in the Go SDK.

    public static class GetElasticsearchQueryRuleset 
{
    public static Task<GetElasticsearchQueryRulesetResult> InvokeAsync(GetElasticsearchQueryRulesetArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchQueryRulesetResult> Invoke(GetElasticsearchQueryRulesetInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetElasticsearchQueryRulesetResult> getElasticsearchQueryRuleset(GetElasticsearchQueryRulesetArgs args, InvokeOptions options)
public static Output<GetElasticsearchQueryRulesetResult> getElasticsearchQueryRuleset(GetElasticsearchQueryRulesetArgs args, InvokeOptions options)

    fn::invoke:
  function: elasticstack:index/getElasticsearchQueryRuleset:getElasticsearchQueryRuleset
  arguments:
    # arguments dictionary
    data "elasticstack_getelasticsearchqueryruleset" "name" {
    # arguments
}

    The following arguments are supported:

    RulesetId string
    Unique identifier of the query ruleset to look up.
    ElasticsearchConnections List<GetElasticsearchQueryRulesetElasticsearchConnection>
    Elasticsearch connection configuration block.
    RulesetId string
    Unique identifier of the query ruleset to look up.
    ElasticsearchConnections []GetElasticsearchQueryRulesetElasticsearchConnection
    Elasticsearch connection configuration block.
    ruleset_id string
    Unique identifier of the query ruleset to look up.
    elasticsearch_connections list(object)
    Elasticsearch connection configuration block.
    rulesetId String
    Unique identifier of the query ruleset to look up.
    elasticsearchConnections List<GetElasticsearchQueryRulesetElasticsearchConnection>
    Elasticsearch connection configuration block.
    rulesetId string
    Unique identifier of the query ruleset to look up.
    elasticsearchConnections GetElasticsearchQueryRulesetElasticsearchConnection[]
    Elasticsearch connection configuration block.
    ruleset_id str
    Unique identifier of the query ruleset to look up.
    elasticsearch_connections Sequence[GetElasticsearchQueryRulesetElasticsearchConnection]
    Elasticsearch connection configuration block.
    rulesetId String
    Unique identifier of the query ruleset to look up.
    elasticsearchConnections List<Property Map>
    Elasticsearch connection configuration block.

    getElasticsearchQueryRuleset Result

    The following output properties are available:

    Id string
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    Rules List<GetElasticsearchQueryRulesetRule>
    Ordered list of query rules for this ruleset.
    RulesetId string
    Unique identifier of the query ruleset to look up.
    ElasticsearchConnections List<GetElasticsearchQueryRulesetElasticsearchConnection>
    Elasticsearch connection configuration block.
    Id string
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    Rules []GetElasticsearchQueryRulesetRule
    Ordered list of query rules for this ruleset.
    RulesetId string
    Unique identifier of the query ruleset to look up.
    ElasticsearchConnections []GetElasticsearchQueryRulesetElasticsearchConnection
    Elasticsearch connection configuration block.
    id string
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    rules list(object)
    Ordered list of query rules for this ruleset.
    ruleset_id string
    Unique identifier of the query ruleset to look up.
    elasticsearch_connections list(object)
    Elasticsearch connection configuration block.
    id String
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    rules List<GetElasticsearchQueryRulesetRule>
    Ordered list of query rules for this ruleset.
    rulesetId String
    Unique identifier of the query ruleset to look up.
    elasticsearchConnections List<GetElasticsearchQueryRulesetElasticsearchConnection>
    Elasticsearch connection configuration block.
    id string
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    rules GetElasticsearchQueryRulesetRule[]
    Ordered list of query rules for this ruleset.
    rulesetId string
    Unique identifier of the query ruleset to look up.
    elasticsearchConnections GetElasticsearchQueryRulesetElasticsearchConnection[]
    Elasticsearch connection configuration block.
    id str
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    rules Sequence[GetElasticsearchQueryRulesetRule]
    Ordered list of query rules for this ruleset.
    ruleset_id str
    Unique identifier of the query ruleset to look up.
    elasticsearch_connections Sequence[GetElasticsearchQueryRulesetElasticsearchConnection]
    Elasticsearch connection configuration block.
    id String
    Internal identifier in the form <cluster_uuid>/<ruleset_id>.
    rules List<Property Map>
    Ordered list of query rules for this ruleset.
    rulesetId String
    Unique identifier of the query ruleset to look up.
    elasticsearchConnections List<Property Map>
    Elasticsearch connection configuration block.

    Supporting Types

    GetElasticsearchQueryRulesetElasticsearchConnection

    ApiKey string
    API Key to use for authentication to Elasticsearch
    BearerToken string
    Bearer Token to use for authentication to Elasticsearch
    CaData string
    PEM-encoded custom Certificate Authority certificate
    CaFile string
    Path to a custom Certificate Authority certificate
    CertData string
    PEM encoded certificate for client auth
    CertFile string
    Path to a file containing the PEM encoded certificate for client auth
    Endpoints List<string>
    EsClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    Headers Dictionary<string, string>
    A list of headers to be sent with each request to Elasticsearch.
    Insecure bool
    Disable TLS certificate validation
    KeyData string
    PEM encoded private key for client auth
    KeyFile string
    Path to a file containing the PEM encoded private key for client auth
    Password string
    Password to use for API authentication to Elasticsearch.
    Username string
    Username to use for API authentication to Elasticsearch.
    ApiKey string
    API Key to use for authentication to Elasticsearch
    BearerToken string
    Bearer Token to use for authentication to Elasticsearch
    CaData string
    PEM-encoded custom Certificate Authority certificate
    CaFile string
    Path to a custom Certificate Authority certificate
    CertData string
    PEM encoded certificate for client auth
    CertFile string
    Path to a file containing the PEM encoded certificate for client auth
    Endpoints []string
    EsClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    Headers map[string]string
    A list of headers to be sent with each request to Elasticsearch.
    Insecure bool
    Disable TLS certificate validation
    KeyData string
    PEM encoded private key for client auth
    KeyFile string
    Path to a file containing the PEM encoded private key for client auth
    Password string
    Password to use for API authentication to Elasticsearch.
    Username string
    Username to use for API authentication to Elasticsearch.
    api_key string
    API Key to use for authentication to Elasticsearch
    bearer_token string
    Bearer Token to use for authentication to Elasticsearch
    ca_data string
    PEM-encoded custom Certificate Authority certificate
    ca_file string
    Path to a custom Certificate Authority certificate
    cert_data string
    PEM encoded certificate for client auth
    cert_file string
    Path to a file containing the PEM encoded certificate for client auth
    endpoints list(string)
    es_client_authentication string
    ES Client Authentication field to be used with the JWT token
    headers map(string)
    A list of headers to be sent with each request to Elasticsearch.
    insecure bool
    Disable TLS certificate validation
    key_data string
    PEM encoded private key for client auth
    key_file string
    Path to a file containing the PEM encoded private key for client auth
    password string
    Password to use for API authentication to Elasticsearch.
    username string
    Username to use for API authentication to Elasticsearch.
    apiKey String
    API Key to use for authentication to Elasticsearch
    bearerToken String
    Bearer Token to use for authentication to Elasticsearch
    caData String
    PEM-encoded custom Certificate Authority certificate
    caFile String
    Path to a custom Certificate Authority certificate
    certData String
    PEM encoded certificate for client auth
    certFile String
    Path to a file containing the PEM encoded certificate for client auth
    endpoints List<String>
    esClientAuthentication String
    ES Client Authentication field to be used with the JWT token
    headers Map<String,String>
    A list of headers to be sent with each request to Elasticsearch.
    insecure Boolean
    Disable TLS certificate validation
    keyData String
    PEM encoded private key for client auth
    keyFile String
    Path to a file containing the PEM encoded private key for client auth
    password String
    Password to use for API authentication to Elasticsearch.
    username String
    Username to use for API authentication to Elasticsearch.
    apiKey string
    API Key to use for authentication to Elasticsearch
    bearerToken string
    Bearer Token to use for authentication to Elasticsearch
    caData string
    PEM-encoded custom Certificate Authority certificate
    caFile string
    Path to a custom Certificate Authority certificate
    certData string
    PEM encoded certificate for client auth
    certFile string
    Path to a file containing the PEM encoded certificate for client auth
    endpoints string[]
    esClientAuthentication string
    ES Client Authentication field to be used with the JWT token
    headers {[key: string]: string}
    A list of headers to be sent with each request to Elasticsearch.
    insecure boolean
    Disable TLS certificate validation
    keyData string
    PEM encoded private key for client auth
    keyFile string
    Path to a file containing the PEM encoded private key for client auth
    password string
    Password to use for API authentication to Elasticsearch.
    username string
    Username to use for API authentication to Elasticsearch.
    api_key str
    API Key to use for authentication to Elasticsearch
    bearer_token str
    Bearer Token to use for authentication to Elasticsearch
    ca_data str
    PEM-encoded custom Certificate Authority certificate
    ca_file str
    Path to a custom Certificate Authority certificate
    cert_data str
    PEM encoded certificate for client auth
    cert_file str
    Path to a file containing the PEM encoded certificate for client auth
    endpoints Sequence[str]
    es_client_authentication str
    ES Client Authentication field to be used with the JWT token
    headers Mapping[str, str]
    A list of headers to be sent with each request to Elasticsearch.
    insecure bool
    Disable TLS certificate validation
    key_data str
    PEM encoded private key for client auth
    key_file str
    Path to a file containing the PEM encoded private key for client auth
    password str
    Password to use for API authentication to Elasticsearch.
    username str
    Username to use for API authentication to Elasticsearch.
    apiKey String
    API Key to use for authentication to Elasticsearch
    bearerToken String
    Bearer Token to use for authentication to Elasticsearch
    caData String
    PEM-encoded custom Certificate Authority certificate
    caFile String
    Path to a custom Certificate Authority certificate
    certData String
    PEM encoded certificate for client auth
    certFile String
    Path to a file containing the PEM encoded certificate for client auth
    endpoints List<String>
    esClientAuthentication String
    ES Client Authentication field to be used with the JWT token
    headers Map<String>
    A list of headers to be sent with each request to Elasticsearch.
    insecure Boolean
    Disable TLS certificate validation
    keyData String
    PEM encoded private key for client auth
    keyFile String
    Path to a file containing the PEM encoded private key for client auth
    password String
    Password to use for API authentication to Elasticsearch.
    username String
    Username to use for API authentication to Elasticsearch.

    GetElasticsearchQueryRulesetRule

    Actions GetElasticsearchQueryRulesetRuleActions
    Actions taken when the rule matches.
    Criterias List<GetElasticsearchQueryRulesetRuleCriteria>
    Match criteria for the rule.
    Priority double
    Relative priority within the ruleset.
    RuleId string
    Unique identifier for the rule within the ruleset.
    Type string
    Rule type: pinned or exclude.
    Actions GetElasticsearchQueryRulesetRuleActions
    Actions taken when the rule matches.
    Criterias []GetElasticsearchQueryRulesetRuleCriteria
    Match criteria for the rule.
    Priority float64
    Relative priority within the ruleset.
    RuleId string
    Unique identifier for the rule within the ruleset.
    Type string
    Rule type: pinned or exclude.
    actions object
    Actions taken when the rule matches.
    criterias list(object)
    Match criteria for the rule.
    priority number
    Relative priority within the ruleset.
    rule_id string
    Unique identifier for the rule within the ruleset.
    type string
    Rule type: pinned or exclude.
    actions GetElasticsearchQueryRulesetRuleActions
    Actions taken when the rule matches.
    criterias List<GetElasticsearchQueryRulesetRuleCriteria>
    Match criteria for the rule.
    priority Double
    Relative priority within the ruleset.
    ruleId String
    Unique identifier for the rule within the ruleset.
    type String
    Rule type: pinned or exclude.
    actions GetElasticsearchQueryRulesetRuleActions
    Actions taken when the rule matches.
    criterias GetElasticsearchQueryRulesetRuleCriteria[]
    Match criteria for the rule.
    priority number
    Relative priority within the ruleset.
    ruleId string
    Unique identifier for the rule within the ruleset.
    type string
    Rule type: pinned or exclude.
    actions GetElasticsearchQueryRulesetRuleActions
    Actions taken when the rule matches.
    criterias Sequence[GetElasticsearchQueryRulesetRuleCriteria]
    Match criteria for the rule.
    priority float
    Relative priority within the ruleset.
    rule_id str
    Unique identifier for the rule within the ruleset.
    type str
    Rule type: pinned or exclude.
    actions Property Map
    Actions taken when the rule matches.
    criterias List<Property Map>
    Match criteria for the rule.
    priority Number
    Relative priority within the ruleset.
    ruleId String
    Unique identifier for the rule within the ruleset.
    type String
    Rule type: pinned or exclude.

    GetElasticsearchQueryRulesetRuleActions

    Docs List<GetElasticsearchQueryRulesetRuleActionsDoc>
    Documents pinned or excluded.
    Ids List<string>
    Document IDs pinned or excluded.
    Docs []GetElasticsearchQueryRulesetRuleActionsDoc
    Documents pinned or excluded.
    Ids []string
    Document IDs pinned or excluded.
    docs list(object)
    Documents pinned or excluded.
    ids list(string)
    Document IDs pinned or excluded.
    docs List<GetElasticsearchQueryRulesetRuleActionsDoc>
    Documents pinned or excluded.
    ids List<String>
    Document IDs pinned or excluded.
    docs GetElasticsearchQueryRulesetRuleActionsDoc[]
    Documents pinned or excluded.
    ids string[]
    Document IDs pinned or excluded.
    docs Sequence[GetElasticsearchQueryRulesetRuleActionsDoc]
    Documents pinned or excluded.
    ids Sequence[str]
    Document IDs pinned or excluded.
    docs List<Property Map>
    Documents pinned or excluded.
    ids List<String>
    Document IDs pinned or excluded.

    GetElasticsearchQueryRulesetRuleActionsDoc

    _id string
    Unique document ID.
    _index string
    Index containing the document.
    _id string
    Unique document ID.
    _index string
    Index containing the document.
    _id string
    Unique document ID.
    _index string
    Index containing the document.
    _id String
    Unique document ID.
    _index String
    Index containing the document.
    _id string
    Unique document ID.
    _index string
    Index containing the document.
    _id str
    Unique document ID.
    _index str
    Index containing the document.
    _id String
    Unique document ID.
    _index String
    Index containing the document.

    GetElasticsearchQueryRulesetRuleCriteria

    Metadata string
    Metadata field matched against.
    Type string
    Criteria type.
    Values string
    JSON-encoded array of string or numeric values.
    Metadata string
    Metadata field matched against.
    Type string
    Criteria type.
    Values string
    JSON-encoded array of string or numeric values.
    metadata string
    Metadata field matched against.
    type string
    Criteria type.
    values string
    JSON-encoded array of string or numeric values.
    metadata String
    Metadata field matched against.
    type String
    Criteria type.
    values String
    JSON-encoded array of string or numeric values.
    metadata string
    Metadata field matched against.
    type string
    Criteria type.
    values string
    JSON-encoded array of string or numeric values.
    metadata str
    Metadata field matched against.
    type str
    Criteria type.
    values str
    JSON-encoded array of string or numeric values.
    metadata String
    Metadata field matched against.
    type String
    Criteria type.
    values String
    JSON-encoded array of string or numeric values.

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    Viewing docs for elasticstack 0.16.1
    published on Monday, Jun 1, 2026 by elastic
    Schema (JSON)
    elastic/terraform-provider-elasticstack

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial