elasticstack 0.12.1 published on Thursday, Oct 23, 2025 by elastic
elasticstack.getElasticsearchIngestProcessorJoin
Start a Neo task
Explain and create an elasticstack.getElasticsearchIngestProcessorJoin resource
elasticstack 0.12.1 published on Thursday, Oct 23, 2025 by elastic
Helper data source which can be used to create the configuration for a join processor. This processor joins each element of an array into a single string using a separator character between each element. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as elasticstack from "@pulumi/elasticstack";
const join = elasticstack.getElasticsearchIngestProcessorJoin({
field: "joined_array_field",
separator: "-",
});
const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [join.then(join => join.json)]});
import pulumi
import pulumi_elasticstack as elasticstack
join = elasticstack.get_elasticsearch_ingest_processor_join(field="joined_array_field",
separator="-")
my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[join.json])
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 {
join, err := elasticstack.GetElasticsearchIngestProcessorJoin(ctx, &elasticstack.GetElasticsearchIngestProcessorJoinArgs{
Field: "joined_array_field",
Separator: "-",
}, nil)
if err != nil {
return err
}
_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
Processors: pulumi.StringArray{
pulumi.String(join.Json),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Elasticstack = Pulumi.Elasticstack;
return await Deployment.RunAsync(() =>
{
var @join = Elasticstack.GetElasticsearchIngestProcessorJoin.Invoke(new()
{
Field = "joined_array_field",
Separator = "-",
});
var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
{
Processors = new[]
{
@join.Apply(@join => @join.Apply(getElasticsearchIngestProcessorJoinResult => getElasticsearchIngestProcessorJoinResult.Json)),
},
});
});
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.GetElasticsearchIngestProcessorJoinArgs;
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 join = ElasticstackFunctions.getElasticsearchIngestProcessorJoin(GetElasticsearchIngestProcessorJoinArgs.builder()
.field("joined_array_field")
.separator("-")
.build());
var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
.processors(join.applyValue(getElasticsearchIngestProcessorJoinResult -> getElasticsearchIngestProcessorJoinResult.json()))
.build());
}
}
resources:
myIngestPipeline:
type: elasticstack:ElasticsearchIngestPipeline
properties:
processors:
- ${join.json}
variables:
join:
fn::invoke:
function: elasticstack:getElasticsearchIngestProcessorJoin
arguments:
field: joined_array_field
separator: '-'
Using getElasticsearchIngestProcessorJoin
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 getElasticsearchIngestProcessorJoin(args: GetElasticsearchIngestProcessorJoinArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorJoinResult>
function getElasticsearchIngestProcessorJoinOutput(args: GetElasticsearchIngestProcessorJoinOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorJoinResult>def get_elasticsearch_ingest_processor_join(description: Optional[str] = None,
field: Optional[str] = None,
if_: Optional[str] = None,
ignore_failure: Optional[bool] = None,
on_failures: Optional[Sequence[str]] = None,
separator: Optional[str] = None,
tag: Optional[str] = None,
target_field: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorJoinResult
def get_elasticsearch_ingest_processor_join_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,
on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = 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[GetElasticsearchIngestProcessorJoinResult]func GetElasticsearchIngestProcessorJoin(ctx *Context, args *GetElasticsearchIngestProcessorJoinArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorJoinResult, error)
func GetElasticsearchIngestProcessorJoinOutput(ctx *Context, args *GetElasticsearchIngestProcessorJoinOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorJoinResultOutput> Note: This function is named GetElasticsearchIngestProcessorJoin in the Go SDK.
public static class GetElasticsearchIngestProcessorJoin
{
public static Task<GetElasticsearchIngestProcessorJoinResult> InvokeAsync(GetElasticsearchIngestProcessorJoinArgs args, InvokeOptions? opts = null)
public static Output<GetElasticsearchIngestProcessorJoinResult> Invoke(GetElasticsearchIngestProcessorJoinInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetElasticsearchIngestProcessorJoinResult> getElasticsearchIngestProcessorJoin(GetElasticsearchIngestProcessorJoinArgs args, InvokeOptions options)
public static Output<GetElasticsearchIngestProcessorJoinResult> getElasticsearchIngestProcessorJoin(GetElasticsearchIngestProcessorJoinArgs args, InvokeOptions options)
fn::invoke:
function: elasticstack:index/getElasticsearchIngestProcessorJoin:getElasticsearchIngestProcessorJoin
arguments:
# arguments dictionaryThe following arguments are supported:
- Field string
- Field containing array values to join.
- Separator string
- The separator character.
- Description string
- Description of the processor.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- On
Failures List<string> - Handle failures for the processor.
- Tag string
- Identifier for the processor.
- Target
Field string - The field to assign the converted value to, by default
fieldis updated in-place.
- Field string
- Field containing array values to join.
- Separator string
- The separator character.
- Description string
- Description of the processor.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- On
Failures []string - Handle failures for the processor.
- Tag string
- Identifier for the processor.
- Target
Field string - The field to assign the converted value to, by default
fieldis updated in-place.
- field String
- Field containing array values to join.
- separator String
- The separator character.
- description String
- Description of the processor.
- if_ String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- on
Failures List<String> - Handle failures for the processor.
- tag String
- Identifier for the processor.
- target
Field String - The field to assign the converted value to, by default
fieldis updated in-place.
- field string
- Field containing array values to join.
- separator string
- The separator character.
- description string
- Description of the processor.
- if string
- Conditionally execute the processor
- ignore
Failure boolean - Ignore failures for the processor.
- on
Failures string[] - Handle failures for the processor.
- tag string
- Identifier for the processor.
- target
Field string - The field to assign the converted value to, by default
fieldis updated in-place.
- field str
- Field containing array values to join.
- separator str
- The separator character.
- description str
- Description of the processor.
- if_ str
- Conditionally execute the processor
- ignore_
failure bool - Ignore failures for the processor.
- on_
failures Sequence[str] - Handle failures for the processor.
- tag str
- Identifier for the processor.
- target_
field str - The field to assign the converted value to, by default
fieldis updated in-place.
- field String
- Field containing array values to join.
- separator String
- The separator character.
- description String
- Description of the processor.
- if String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- on
Failures List<String> - Handle failures for the processor.
- tag String
- Identifier for the processor.
- target
Field String - The field to assign the converted value to, by default
fieldis updated in-place.
getElasticsearchIngestProcessorJoin Result
The following output properties are available:
- Field string
- Field containing array values to join.
- Id string
- Internal identifier of the resource.
- Json string
- JSON representation of this data source.
- Separator string
- The separator character.
- Description string
- Description of the processor.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- On
Failures List<string> - Handle failures for the processor.
- Tag string
- Identifier for the processor.
- Target
Field string - The field to assign the converted value to, by default
fieldis updated in-place.
- Field string
- Field containing array values to join.
- Id string
- Internal identifier of the resource.
- Json string
- JSON representation of this data source.
- Separator string
- The separator character.
- Description string
- Description of the processor.
- If string
- Conditionally execute the processor
- Ignore
Failure bool - Ignore failures for the processor.
- On
Failures []string - Handle failures for the processor.
- Tag string
- Identifier for the processor.
- Target
Field string - The field to assign the converted value to, by default
fieldis updated in-place.
- field String
- Field containing array values to join.
- id String
- Internal identifier of the resource.
- json String
- JSON representation of this data source.
- separator String
- The separator character.
- description String
- Description of the processor.
- if_ String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- on
Failures List<String> - Handle failures for the processor.
- tag String
- Identifier for the processor.
- target
Field String - The field to assign the converted value to, by default
fieldis updated in-place.
- field string
- Field containing array values to join.
- id string
- Internal identifier of the resource.
- json string
- JSON representation of this data source.
- separator string
- The separator character.
- description string
- Description of the processor.
- if string
- Conditionally execute the processor
- ignore
Failure boolean - Ignore failures for the processor.
- on
Failures string[] - Handle failures for the processor.
- tag string
- Identifier for the processor.
- target
Field string - The field to assign the converted value to, by default
fieldis updated in-place.
- field str
- Field containing array values to join.
- id str
- Internal identifier of the resource.
- json str
- JSON representation of this data source.
- separator str
- The separator character.
- description str
- Description of the processor.
- if_ str
- Conditionally execute the processor
- ignore_
failure bool - Ignore failures for the processor.
- on_
failures Sequence[str] - Handle failures for the processor.
- tag str
- Identifier for the processor.
- target_
field str - The field to assign the converted value to, by default
fieldis updated in-place.
- field String
- Field containing array values to join.
- id String
- Internal identifier of the resource.
- json String
- JSON representation of this data source.
- separator String
- The separator character.
- description String
- Description of the processor.
- if String
- Conditionally execute the processor
- ignore
Failure Boolean - Ignore failures for the processor.
- on
Failures List<String> - Handle failures for the processor.
- tag String
- Identifier for the processor.
- target
Field String - The field to assign the converted value to, by default
fieldis updated in-place.
Package Details
- Repository
- elasticstack elastic/terraform-provider-elasticstack
- License
- Notes
- This Pulumi package is based on the
elasticstackTerraform Provider.
elasticstack 0.12.1 published on Thursday, Oct 23, 2025 by elastic
