1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getElasticsearchIngestProcessorRemove
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

elasticstack.getElasticsearchIngestProcessorRemove

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic

    Removes existing fields. If one field doesn’t exist, an exception will be thrown.

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const remove = elasticstack.getElasticsearchIngestProcessorRemove({
        fields: [
            "user_agent",
            "url",
        ],
    });
    const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [remove.then(remove => remove.json)]});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    remove = elasticstack.get_elasticsearch_ingest_processor_remove(fields=[
        "user_agent",
        "url",
    ])
    my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[remove.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 {
    		remove, err := elasticstack.GetElasticsearchIngestProcessorRemove(ctx, &elasticstack.GetElasticsearchIngestProcessorRemoveArgs{
    			Fields: []string{
    				"user_agent",
    				"url",
    			},
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
    			Processors: pulumi.StringArray{
    				pulumi.String(remove.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 @remove = Elasticstack.GetElasticsearchIngestProcessorRemove.Invoke(new()
        {
            Fields = new[]
            {
                "user_agent",
                "url",
            },
        });
    
        var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
        {
            Processors = new[]
            {
                @remove.Apply(@remove => @remove.Apply(getElasticsearchIngestProcessorRemoveResult => getElasticsearchIngestProcessorRemoveResult.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.GetElasticsearchIngestProcessorRemoveArgs;
    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 remove = ElasticstackFunctions.getElasticsearchIngestProcessorRemove(GetElasticsearchIngestProcessorRemoveArgs.builder()
                .fields(            
                    "user_agent",
                    "url")
                .build());
    
            var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
                .processors(remove.applyValue(getElasticsearchIngestProcessorRemoveResult -> getElasticsearchIngestProcessorRemoveResult.json()))
                .build());
    
        }
    }
    
    resources:
      myIngestPipeline:
        type: elasticstack:ElasticsearchIngestPipeline
        properties:
          processors:
            - ${remove.json}
    variables:
      remove:
        fn::invoke:
          function: elasticstack:getElasticsearchIngestProcessorRemove
          arguments:
            fields:
              - user_agent
              - url
    

    Using getElasticsearchIngestProcessorRemove

    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 getElasticsearchIngestProcessorRemove(args: GetElasticsearchIngestProcessorRemoveArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorRemoveResult>
    function getElasticsearchIngestProcessorRemoveOutput(args: GetElasticsearchIngestProcessorRemoveOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorRemoveResult>
    def get_elasticsearch_ingest_processor_remove(description: Optional[str] = None,
                                                  fields: Optional[Sequence[str]] = None,
                                                  if_: Optional[str] = None,
                                                  ignore_failure: Optional[bool] = None,
                                                  ignore_missing: Optional[bool] = None,
                                                  on_failures: Optional[Sequence[str]] = None,
                                                  tag: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorRemoveResult
    def get_elasticsearch_ingest_processor_remove_output(description: Optional[pulumi.Input[str]] = None,
                                                  fields: Optional[pulumi.Input[Sequence[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,
                                                  tag: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorRemoveResult]
    func GetElasticsearchIngestProcessorRemove(ctx *Context, args *GetElasticsearchIngestProcessorRemoveArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorRemoveResult, error)
    func GetElasticsearchIngestProcessorRemoveOutput(ctx *Context, args *GetElasticsearchIngestProcessorRemoveOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorRemoveResultOutput

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

    public static class GetElasticsearchIngestProcessorRemove 
    {
        public static Task<GetElasticsearchIngestProcessorRemoveResult> InvokeAsync(GetElasticsearchIngestProcessorRemoveArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorRemoveResult> Invoke(GetElasticsearchIngestProcessorRemoveInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorRemoveResult> getElasticsearchIngestProcessorRemove(GetElasticsearchIngestProcessorRemoveArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorRemoveResult> getElasticsearchIngestProcessorRemove(GetElasticsearchIngestProcessorRemoveArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorRemove:getElasticsearchIngestProcessorRemove
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Fields List<string>
    Fields to be removed.
    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.
    Tag string
    Identifier for the processor.
    Fields []string
    Fields to be removed.
    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.
    Tag string
    Identifier for the processor.
    fields List<String>
    Fields to be removed.
    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.
    tag String
    Identifier for the processor.
    fields string[]
    Fields to be removed.
    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.
    tag string
    Identifier for the processor.
    fields Sequence[str]
    Fields to be removed.
    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.
    tag str
    Identifier for the processor.
    fields List<String>
    Fields to be removed.
    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.
    tag String
    Identifier for the processor.

    getElasticsearchIngestProcessorRemove Result

    The following output properties are available:

    Fields List<string>
    Fields to be removed.
    Id string
    Internal identifier of the resource.
    Json string
    JSON representation of this data source.
    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.
    Tag string
    Identifier for the processor.
    Fields []string
    Fields to be removed.
    Id string
    Internal identifier of the resource.
    Json string
    JSON representation of this data source.
    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.
    Tag string
    Identifier for the processor.
    fields List<String>
    Fields to be removed.
    id String
    Internal identifier of the resource.
    json String
    JSON representation of this data source.
    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.
    tag String
    Identifier for the processor.
    fields string[]
    Fields to be removed.
    id string
    Internal identifier of the resource.
    json string
    JSON representation of this data source.
    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.
    tag string
    Identifier for the processor.
    fields Sequence[str]
    Fields to be removed.
    id str
    Internal identifier of the resource.
    json str
    JSON representation of this data source.
    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.
    tag str
    Identifier for the processor.
    fields List<String>
    Fields to be removed.
    id String
    Internal identifier of the resource.
    json String
    JSON representation of this data source.
    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.
    tag String
    Identifier for the processor.

    Package Details

    Repository
    elasticstack elastic/terraform-provider-elasticstack
    License
    Notes
    This Pulumi package is based on the elasticstack Terraform Provider.
    elasticstack logo
    elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic