1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getElasticsearchIngestProcessorSplit
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic

elasticstack.getElasticsearchIngestProcessorSplit

Explore with Pulumi AI

Splits a field into an array using a separator character. Only works on string fields.

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html

Example Usage

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

const split = elasticstack.getElasticsearchIngestProcessorSplit({
    field: "my_field",
    separator: "\\s+",
});
const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [split.then(split => split.json)]});
Copy
import pulumi
import pulumi_elasticstack as elasticstack

split = elasticstack.get_elasticsearch_ingest_processor_split(field="my_field",
    separator="\\s+")
my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[split.json])
Copy
package main

import (
	"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 {
		split, err := elasticstack.GetElasticsearchIngestProcessorSplit(ctx, &elasticstack.GetElasticsearchIngestProcessorSplitArgs{
			Field:     "my_field",
			Separator: "\\s+",
		}, nil)
		if err != nil {
			return err
		}
		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
			Processors: pulumi.StringArray{
				pulumi.String(split.Json),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;

return await Deployment.RunAsync(() => 
{
    var split = Elasticstack.GetElasticsearchIngestProcessorSplit.Invoke(new()
    {
        Field = "my_field",
        Separator = "\\s+",
    });

    var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
    {
        Processors = new[]
        {
            split.Apply(getElasticsearchIngestProcessorSplitResult => getElasticsearchIngestProcessorSplitResult.Json),
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.elasticstack.ElasticstackFunctions;
import com.pulumi.elasticstack.inputs.GetElasticsearchIngestProcessorSplitArgs;
import com.pulumi.elasticstack.ElasticsearchIngestPipeline;
import com.pulumi.elasticstack.ElasticsearchIngestPipelineArgs;
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) {
        final var split = ElasticstackFunctions.getElasticsearchIngestProcessorSplit(GetElasticsearchIngestProcessorSplitArgs.builder()
            .field("my_field")
            .separator("\\s+")
            .build());

        var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
            .processors(split.applyValue(getElasticsearchIngestProcessorSplitResult -> getElasticsearchIngestProcessorSplitResult.json()))
            .build());

    }
}
Copy
resources:
  myIngestPipeline:
    type: elasticstack:ElasticsearchIngestPipeline
    properties:
      processors:
        - ${split.json}
variables:
  split:
    fn::invoke:
      function: elasticstack:getElasticsearchIngestProcessorSplit
      arguments:
        field: my_field
        separator: \s+
Copy

Using getElasticsearchIngestProcessorSplit

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 getElasticsearchIngestProcessorSplit(args: GetElasticsearchIngestProcessorSplitArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorSplitResult>
function getElasticsearchIngestProcessorSplitOutput(args: GetElasticsearchIngestProcessorSplitOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorSplitResult>
Copy
def get_elasticsearch_ingest_processor_split(description: Optional[str] = None,
                                             field: Optional[str] = None,
                                             if_: Optional[str] = None,
                                             ignore_failure: Optional[bool] = None,
                                             ignore_missing: Optional[bool] = None,
                                             on_failures: Optional[Sequence[str]] = None,
                                             preserve_trailing: Optional[bool] = None,
                                             separator: Optional[str] = None,
                                             tag: Optional[str] = None,
                                             target_field: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorSplitResult
def get_elasticsearch_ingest_processor_split_output(description: Optional[pulumi.Input[str]] = None,
                                             field: Optional[pulumi.Input[str]] = None,
                                             if_: Optional[pulumi.Input[str]] = None,
                                             ignore_failure: Optional[pulumi.Input[bool]] = None,
                                             ignore_missing: Optional[pulumi.Input[bool]] = None,
                                             on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                             preserve_trailing: Optional[pulumi.Input[bool]] = None,
                                             separator: Optional[pulumi.Input[str]] = None,
                                             tag: Optional[pulumi.Input[str]] = None,
                                             target_field: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorSplitResult]
Copy
func GetElasticsearchIngestProcessorSplit(ctx *Context, args *GetElasticsearchIngestProcessorSplitArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorSplitResult, error)
func GetElasticsearchIngestProcessorSplitOutput(ctx *Context, args *GetElasticsearchIngestProcessorSplitOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorSplitResultOutput
Copy

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

public static class GetElasticsearchIngestProcessorSplit 
{
    public static Task<GetElasticsearchIngestProcessorSplitResult> InvokeAsync(GetElasticsearchIngestProcessorSplitArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchIngestProcessorSplitResult> Invoke(GetElasticsearchIngestProcessorSplitInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetElasticsearchIngestProcessorSplitResult> getElasticsearchIngestProcessorSplit(GetElasticsearchIngestProcessorSplitArgs args, InvokeOptions options)
public static Output<GetElasticsearchIngestProcessorSplitResult> getElasticsearchIngestProcessorSplit(GetElasticsearchIngestProcessorSplitArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: elasticstack:index/getElasticsearchIngestProcessorSplit:getElasticsearchIngestProcessorSplit
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Field This property is required. string
The field to split
Separator This property is required. string
A regex which matches the separator, eg , or \s+
Description string
Description of the processor.
If string
Conditionally execute the processor
IgnoreFailure bool
Ignore failures for the processor.
IgnoreMissing bool
If true and field does not exist or is null, the processor quietly exits without modifying the document.
OnFailures List<string>
Handle failures for the processor.
PreserveTrailing bool
Preserves empty trailing fields, if any.
Tag string
Identifier for the processor.
TargetField string
The field to assign the converted value to, by default field is updated in-place.
Field This property is required. string
The field to split
Separator This property is required. string
A regex which matches the separator, eg , or \s+
Description string
Description of the processor.
If string
Conditionally execute the processor
IgnoreFailure bool
Ignore failures for the processor.
IgnoreMissing bool
If true and field does not exist or is null, the processor quietly exits without modifying the document.
OnFailures []string
Handle failures for the processor.
PreserveTrailing bool
Preserves empty trailing fields, if any.
Tag string
Identifier for the processor.
TargetField string
The field to assign the converted value to, by default field is updated in-place.
field This property is required. String
The field to split
separator This property is required. String
A regex which matches the separator, eg , or \s+
description String
Description of the processor.
if_ String
Conditionally execute the processor
ignoreFailure Boolean
Ignore failures for the processor.
ignoreMissing Boolean
If true and field does not exist or is null, the processor quietly exits without modifying the document.
onFailures List<String>
Handle failures for the processor.
preserveTrailing Boolean
Preserves empty trailing fields, if any.
tag String
Identifier for the processor.
targetField String
The field to assign the converted value to, by default field is updated in-place.
field This property is required. string
The field to split
separator This property is required. string
A regex which matches the separator, eg , or \s+
description string
Description of the processor.
if string
Conditionally execute the processor
ignoreFailure boolean
Ignore failures for the processor.
ignoreMissing boolean
If true and field does not exist or is null, the processor quietly exits without modifying the document.
onFailures string[]
Handle failures for the processor.
preserveTrailing boolean
Preserves empty trailing fields, if any.
tag string
Identifier for the processor.
targetField string
The field to assign the converted value to, by default field is updated in-place.
field This property is required. str
The field to split
separator This property is required. str
A regex which matches the separator, eg , or \s+
description str
Description of the processor.
if_ str
Conditionally execute the processor
ignore_failure bool
Ignore failures for the processor.
ignore_missing bool
If true and field does not exist or is null, the processor quietly exits without modifying the document.
on_failures Sequence[str]
Handle failures for the processor.
preserve_trailing bool
Preserves empty trailing fields, if any.
tag str
Identifier for the processor.
target_field str
The field to assign the converted value to, by default field is updated in-place.
field This property is required. String
The field to split
separator This property is required. String
A regex which matches the separator, eg , or \s+
description String
Description of the processor.
if String
Conditionally execute the processor
ignoreFailure Boolean
Ignore failures for the processor.
ignoreMissing Boolean
If true and field does not exist or is null, the processor quietly exits without modifying the document.
onFailures List<String>
Handle failures for the processor.
preserveTrailing Boolean
Preserves empty trailing fields, if any.
tag String
Identifier for the processor.
targetField String
The field to assign the converted value to, by default field is updated in-place.

getElasticsearchIngestProcessorSplit Result

The following output properties are available:

Field string
The field to split
Id string
Internal identifier of the resource.
Json string
JSON representation of this data source.
Separator string
A regex which matches the separator, eg , or \s+
Description string
Description of the processor.
If string
Conditionally execute the processor
IgnoreFailure bool
Ignore failures for the processor.
IgnoreMissing bool
If true and field does not exist or is null, the processor quietly exits without modifying the document.
OnFailures List<string>
Handle failures for the processor.
PreserveTrailing bool
Preserves empty trailing fields, if any.
Tag string
Identifier for the processor.
TargetField string
The field to assign the converted value to, by default field is updated in-place.
Field string
The field to split
Id string
Internal identifier of the resource.
Json string
JSON representation of this data source.
Separator string
A regex which matches the separator, eg , or \s+
Description string
Description of the processor.
If string
Conditionally execute the processor
IgnoreFailure bool
Ignore failures for the processor.
IgnoreMissing bool
If true and field does not exist or is null, the processor quietly exits without modifying the document.
OnFailures []string
Handle failures for the processor.
PreserveTrailing bool
Preserves empty trailing fields, if any.
Tag string
Identifier for the processor.
TargetField string
The field to assign the converted value to, by default field is updated in-place.
field String
The field to split
id String
Internal identifier of the resource.
json String
JSON representation of this data source.
separator String
A regex which matches the separator, eg , or \s+
description String
Description of the processor.
if_ String
Conditionally execute the processor
ignoreFailure Boolean
Ignore failures for the processor.
ignoreMissing Boolean
If true and field does not exist or is null, the processor quietly exits without modifying the document.
onFailures List<String>
Handle failures for the processor.
preserveTrailing Boolean
Preserves empty trailing fields, if any.
tag String
Identifier for the processor.
targetField String
The field to assign the converted value to, by default field is updated in-place.
field string
The field to split
id string
Internal identifier of the resource.
json string
JSON representation of this data source.
separator string
A regex which matches the separator, eg , or \s+
description string
Description of the processor.
if string
Conditionally execute the processor
ignoreFailure boolean
Ignore failures for the processor.
ignoreMissing boolean
If true and field does not exist or is null, the processor quietly exits without modifying the document.
onFailures string[]
Handle failures for the processor.
preserveTrailing boolean
Preserves empty trailing fields, if any.
tag string
Identifier for the processor.
targetField string
The field to assign the converted value to, by default field is updated in-place.
field str
The field to split
id str
Internal identifier of the resource.
json str
JSON representation of this data source.
separator str
A regex which matches the separator, eg , or \s+
description str
Description of the processor.
if_ str
Conditionally execute the processor
ignore_failure bool
Ignore failures for the processor.
ignore_missing bool
If true and field does not exist or is null, the processor quietly exits without modifying the document.
on_failures Sequence[str]
Handle failures for the processor.
preserve_trailing bool
Preserves empty trailing fields, if any.
tag str
Identifier for the processor.
target_field str
The field to assign the converted value to, by default field is updated in-place.
field String
The field to split
id String
Internal identifier of the resource.
json String
JSON representation of this data source.
separator String
A regex which matches the separator, eg , or \s+
description String
Description of the processor.
if String
Conditionally execute the processor
ignoreFailure Boolean
Ignore failures for the processor.
ignoreMissing Boolean
If true and field does not exist or is null, the processor quietly exits without modifying the document.
onFailures List<String>
Handle failures for the processor.
preserveTrailing Boolean
Preserves empty trailing fields, if any.
tag String
Identifier for the processor.
targetField String
The field to assign the converted value to, by default field is updated in-place.

Package Details

Repository
elasticstack elastic/terraform-provider-elasticstack
License
Notes
This Pulumi package is based on the elasticstack Terraform Provider.