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

elasticstack.getElasticsearchIngestProcessorDrop

Explore with Pulumi AI

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

    Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const drop = elasticstack.getElasticsearchIngestProcessorDrop({
        "if": "ctx.network_name == 'Guest'",
    });
    const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [drop.then(drop => drop.json)]});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    drop = elasticstack.get_elasticsearch_ingest_processor_drop(if_="ctx.network_name == 'Guest'")
    my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[drop.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 {
    		drop, err := elasticstack.GetElasticsearchIngestProcessorDrop(ctx, &elasticstack.GetElasticsearchIngestProcessorDropArgs{
    			If: pulumi.StringRef("ctx.network_name == 'Guest'"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
    			Processors: pulumi.StringArray{
    				pulumi.String(drop.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 drop = Elasticstack.GetElasticsearchIngestProcessorDrop.Invoke(new()
        {
            If = "ctx.network_name == 'Guest'",
        });
    
        var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
        {
            Processors = new[]
            {
                drop.Apply(getElasticsearchIngestProcessorDropResult => getElasticsearchIngestProcessorDropResult.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.GetElasticsearchIngestProcessorDropArgs;
    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 drop = ElasticstackFunctions.getElasticsearchIngestProcessorDrop(GetElasticsearchIngestProcessorDropArgs.builder()
                .if_("ctx.network_name == 'Guest'")
                .build());
    
            var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
                .processors(drop.applyValue(getElasticsearchIngestProcessorDropResult -> getElasticsearchIngestProcessorDropResult.json()))
                .build());
    
        }
    }
    
    resources:
      myIngestPipeline:
        type: elasticstack:ElasticsearchIngestPipeline
        properties:
          processors:
            - ${drop.json}
    variables:
      drop:
        fn::invoke:
          function: elasticstack:getElasticsearchIngestProcessorDrop
          arguments:
            if: ctx.network_name == 'Guest'
    

    Using getElasticsearchIngestProcessorDrop

    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 getElasticsearchIngestProcessorDrop(args: GetElasticsearchIngestProcessorDropArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorDropResult>
    function getElasticsearchIngestProcessorDropOutput(args: GetElasticsearchIngestProcessorDropOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorDropResult>
    def get_elasticsearch_ingest_processor_drop(description: Optional[str] = None,
                                                if_: Optional[str] = None,
                                                ignore_failure: Optional[bool] = None,
                                                on_failures: Optional[Sequence[str]] = None,
                                                tag: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorDropResult
    def get_elasticsearch_ingest_processor_drop_output(description: 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,
                                                tag: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorDropResult]
    func GetElasticsearchIngestProcessorDrop(ctx *Context, args *GetElasticsearchIngestProcessorDropArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorDropResult, error)
    func GetElasticsearchIngestProcessorDropOutput(ctx *Context, args *GetElasticsearchIngestProcessorDropOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorDropResultOutput

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

    public static class GetElasticsearchIngestProcessorDrop 
    {
        public static Task<GetElasticsearchIngestProcessorDropResult> InvokeAsync(GetElasticsearchIngestProcessorDropArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorDropResult> Invoke(GetElasticsearchIngestProcessorDropInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorDropResult> getElasticsearchIngestProcessorDrop(GetElasticsearchIngestProcessorDropArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorDropResult> getElasticsearchIngestProcessorDrop(GetElasticsearchIngestProcessorDropArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorDrop:getElasticsearchIngestProcessorDrop
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    OnFailures List<string>
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    OnFailures []string
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    description String
    Description of the processor.
    if_ String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.
    description string
    Description of the processor.
    if string
    Conditionally execute the processor
    ignoreFailure boolean
    Ignore failures for the processor.
    onFailures string[]
    Handle failures for the processor.
    tag string
    Identifier for the processor.
    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.
    description String
    Description of the processor.
    if String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.

    getElasticsearchIngestProcessorDrop Result

    The following output properties are available:

    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.
    OnFailures List<string>
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    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.
    OnFailures []string
    Handle failures for the processor.
    Tag string
    Identifier for the processor.
    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.
    onFailures List<String>
    Handle failures for the processor.
    tag String
    Identifier for the processor.
    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.
    onFailures string[]
    Handle failures for the processor.
    tag string
    Identifier for the processor.
    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.
    on_failures Sequence[str]
    Handle failures for the processor.
    tag str
    Identifier for the processor.
    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.
    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