1. Packages
  2. Packages
  3. Elasticstack Provider
  4. API Docs
  5. ElasticsearchMlFilter
Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

elasticstack.ElasticsearchMlFilter

Viewing docs for elasticstack 0.15.0
published on Thursday, May 14, 2026 by elastic
Schema (JSON)
elastic/terraform-provider-elasticstack

    Manages Machine Learning filters. A filter contains a list of strings that can be referenced in the custom_rules property of detector configuration objects. See the ML Filter API documentation for more details.

    Create ElasticsearchMlFilter Resource

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

    Constructor syntax

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

@overload
def ElasticsearchMlFilter(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          filter_id: Optional[str] = None,
                          description: Optional[str] = None,
                          elasticsearch_connections: Optional[Sequence[ElasticsearchMlFilterElasticsearchConnectionArgs]] = None,
                          items: Optional[Sequence[str]] = None)
    func NewElasticsearchMlFilter(ctx *Context, name string, args ElasticsearchMlFilterArgs, opts ...ResourceOption) (*ElasticsearchMlFilter, error)
    public ElasticsearchMlFilter(string name, ElasticsearchMlFilterArgs args, CustomResourceOptions? opts = null)
    public ElasticsearchMlFilter(String name, ElasticsearchMlFilterArgs args)
public ElasticsearchMlFilter(String name, ElasticsearchMlFilterArgs args, CustomResourceOptions options)

    type: elasticstack:ElasticsearchMlFilter
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "elasticstack_elasticsearchmlfilter" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ElasticsearchMlFilterArgs
    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 ElasticsearchMlFilterArgs
    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 ElasticsearchMlFilterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ElasticsearchMlFilterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ElasticsearchMlFilterArgs
    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 elasticsearchMlFilterResource = new Elasticstack.ElasticsearchMlFilter("elasticsearchMlFilterResource", new()
{
    FilterId = "string",
    Description = "string",
    ElasticsearchConnections = new[]
    {
        new Elasticstack.Inputs.ElasticsearchMlFilterElasticsearchConnectionArgs
        {
            ApiKey = "string",
            BearerToken = "string",
            CaData = "string",
            CaFile = "string",
            CertData = "string",
            CertFile = "string",
            Endpoints = new[]
            {
                "string",
            },
            EsClientAuthentication = "string",
            Headers = 
            {
                { "string", "string" },
            },
            Insecure = false,
            KeyData = "string",
            KeyFile = "string",
            Password = "string",
            Username = "string",
        },
    },
    Items = new[]
    {
        "string",
    },
});

    example, err := elasticstack.NewElasticsearchMlFilter(ctx, "elasticsearchMlFilterResource", &elasticstack.ElasticsearchMlFilterArgs{
	FilterId:    pulumi.String("string"),
	Description: pulumi.String("string"),
	ElasticsearchConnections: elasticstack.ElasticsearchMlFilterElasticsearchConnectionArray{
		&elasticstack.ElasticsearchMlFilterElasticsearchConnectionArgs{
			ApiKey:      pulumi.String("string"),
			BearerToken: pulumi.String("string"),
			CaData:      pulumi.String("string"),
			CaFile:      pulumi.String("string"),
			CertData:    pulumi.String("string"),
			CertFile:    pulumi.String("string"),
			Endpoints: pulumi.StringArray{
				pulumi.String("string"),
			},
			EsClientAuthentication: pulumi.String("string"),
			Headers: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Insecure: pulumi.Bool(false),
			KeyData:  pulumi.String("string"),
			KeyFile:  pulumi.String("string"),
			Password: pulumi.String("string"),
			Username: pulumi.String("string"),
		},
	},
	Items: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "elasticstack_elasticsearchmlfilter" "elasticsearchMlFilterResource" {
  filter_id   = "string"
  description = "string"
  elasticsearch_connections {
    api_key                  = "string"
    bearer_token             = "string"
    ca_data                  = "string"
    ca_file                  = "string"
    cert_data                = "string"
    cert_file                = "string"
    endpoints                = ["string"]
    es_client_authentication = "string"
    headers = {
      "string" = "string"
    }
    insecure = false
    key_data = "string"
    key_file = "string"
    password = "string"
    username = "string"
  }
  items = ["string"]
}

    var elasticsearchMlFilterResource = new ElasticsearchMlFilter("elasticsearchMlFilterResource", ElasticsearchMlFilterArgs.builder()
    .filterId("string")
    .description("string")
    .elasticsearchConnections(ElasticsearchMlFilterElasticsearchConnectionArgs.builder()
        .apiKey("string")
        .bearerToken("string")
        .caData("string")
        .caFile("string")
        .certData("string")
        .certFile("string")
        .endpoints("string")
        .esClientAuthentication("string")
        .headers(Map.of("string", "string"))
        .insecure(false)
        .keyData("string")
        .keyFile("string")
        .password("string")
        .username("string")
        .build())
    .items("string")
    .build());

    elasticsearch_ml_filter_resource = elasticstack.ElasticsearchMlFilter("elasticsearchMlFilterResource",
    filter_id="string",
    description="string",
    elasticsearch_connections=[{
        "api_key": "string",
        "bearer_token": "string",
        "ca_data": "string",
        "ca_file": "string",
        "cert_data": "string",
        "cert_file": "string",
        "endpoints": ["string"],
        "es_client_authentication": "string",
        "headers": {
            "string": "string",
        },
        "insecure": False,
        "key_data": "string",
        "key_file": "string",
        "password": "string",
        "username": "string",
    }],
    items=["string"])

    const elasticsearchMlFilterResource = new elasticstack.ElasticsearchMlFilter("elasticsearchMlFilterResource", {
    filterId: "string",
    description: "string",
    elasticsearchConnections: [{
        apiKey: "string",
        bearerToken: "string",
        caData: "string",
        caFile: "string",
        certData: "string",
        certFile: "string",
        endpoints: ["string"],
        esClientAuthentication: "string",
        headers: {
            string: "string",
        },
        insecure: false,
        keyData: "string",
        keyFile: "string",
        password: "string",
        username: "string",
    }],
    items: ["string"],
});

    type: elasticstack:ElasticsearchMlFilter
properties:
    description: string
    elasticsearchConnections:
        - apiKey: string
          bearerToken: string
          caData: string
          caFile: string
          certData: string
          certFile: string
          endpoints:
            - string
          esClientAuthentication: string
          headers:
            string: string
          insecure: false
          keyData: string
          keyFile: string
          password: string
          username: string
    filterId: string
    items:
        - string

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

    FilterId string
    A string that uniquely identifies a filter.
    Description string
    A description of the filter.
    ElasticsearchConnections List<ElasticsearchMlFilterElasticsearchConnection>
    Elasticsearch connection configuration block.
    Items List<string>
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    FilterId string
    A string that uniquely identifies a filter.
    Description string
    A description of the filter.
    ElasticsearchConnections []ElasticsearchMlFilterElasticsearchConnectionArgs
    Elasticsearch connection configuration block.
    Items []string
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    filter_id string
    A string that uniquely identifies a filter.
    description string
    A description of the filter.
    elasticsearch_connections list(object)
    Elasticsearch connection configuration block.
    items list(string)
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    filterId String
    A string that uniquely identifies a filter.
    description String
    A description of the filter.
    elasticsearchConnections List<ElasticsearchMlFilterElasticsearchConnection>
    Elasticsearch connection configuration block.
    items List<String>
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    filterId string
    A string that uniquely identifies a filter.
    description string
    A description of the filter.
    elasticsearchConnections ElasticsearchMlFilterElasticsearchConnection[]
    Elasticsearch connection configuration block.
    items string[]
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    filter_id str
    A string that uniquely identifies a filter.
    description str
    A description of the filter.
    elasticsearch_connections Sequence[ElasticsearchMlFilterElasticsearchConnectionArgs]
    Elasticsearch connection configuration block.
    items Sequence[str]
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    filterId String
    A string that uniquely identifies a filter.
    description String
    A description of the filter.
    elasticsearchConnections List<Property Map>
    Elasticsearch connection configuration block.
    items List<String>
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.

    Outputs

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

    Get an existing ElasticsearchMlFilter 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?: ElasticsearchMlFilterState, opts?: CustomResourceOptions): ElasticsearchMlFilter
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        elasticsearch_connections: Optional[Sequence[ElasticsearchMlFilterElasticsearchConnectionArgs]] = None,
        filter_id: Optional[str] = None,
        items: Optional[Sequence[str]] = None) -> ElasticsearchMlFilter
    func GetElasticsearchMlFilter(ctx *Context, name string, id IDInput, state *ElasticsearchMlFilterState, opts ...ResourceOption) (*ElasticsearchMlFilter, error)
    public static ElasticsearchMlFilter Get(string name, Input<string> id, ElasticsearchMlFilterState? state, CustomResourceOptions? opts = null)
    public static ElasticsearchMlFilter get(String name, Output<String> id, ElasticsearchMlFilterState state, CustomResourceOptions options)
    resources:  _:    type: elasticstack:ElasticsearchMlFilter    get:      id: ${id}
    import {
  to = elasticstack_elasticsearchmlfilter.example
  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:
    Description string
    A description of the filter.
    ElasticsearchConnections List<ElasticsearchMlFilterElasticsearchConnection>
    Elasticsearch connection configuration block.
    FilterId string
    A string that uniquely identifies a filter.
    Items List<string>
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    Description string
    A description of the filter.
    ElasticsearchConnections []ElasticsearchMlFilterElasticsearchConnectionArgs
    Elasticsearch connection configuration block.
    FilterId string
    A string that uniquely identifies a filter.
    Items []string
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    description string
    A description of the filter.
    elasticsearch_connections list(object)
    Elasticsearch connection configuration block.
    filter_id string
    A string that uniquely identifies a filter.
    items list(string)
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    description String
    A description of the filter.
    elasticsearchConnections List<ElasticsearchMlFilterElasticsearchConnection>
    Elasticsearch connection configuration block.
    filterId String
    A string that uniquely identifies a filter.
    items List<String>
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    description string
    A description of the filter.
    elasticsearchConnections ElasticsearchMlFilterElasticsearchConnection[]
    Elasticsearch connection configuration block.
    filterId string
    A string that uniquely identifies a filter.
    items string[]
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    description str
    A description of the filter.
    elasticsearch_connections Sequence[ElasticsearchMlFilterElasticsearchConnectionArgs]
    Elasticsearch connection configuration block.
    filter_id str
    A string that uniquely identifies a filter.
    items Sequence[str]
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.
    description String
    A description of the filter.
    elasticsearchConnections List<Property Map>
    Elasticsearch connection configuration block.
    filterId String
    A string that uniquely identifies a filter.
    items List<String>
    The items of the filter. A wildcard * can be used at the beginning or the end of an item. Up to 10000 items are allowed in each filter.

    Supporting Types

    ElasticsearchMlFilterElasticsearchConnection, ElasticsearchMlFilterElasticsearchConnectionArgs

    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.

    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.15.0
    published on Thursday, May 14, 2026 by elastic
    Schema (JSON)
    elastic/terraform-provider-elasticstack
      Try Pulumi Cloud free. Your team will thank you.