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

elasticstack.getElasticsearchIngestProcessorFingerprint

Explore with Pulumi AI

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

    Computes a hash of the document’s content. You can use this hash for content fingerprinting.

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

    Example Usage

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

    Using getElasticsearchIngestProcessorFingerprint

    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 getElasticsearchIngestProcessorFingerprint(args: GetElasticsearchIngestProcessorFingerprintArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorFingerprintResult>
    function getElasticsearchIngestProcessorFingerprintOutput(args: GetElasticsearchIngestProcessorFingerprintOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorFingerprintResult>
    def get_elasticsearch_ingest_processor_fingerprint(description: Optional[str] = None,
                                                       fields: Optional[Sequence[str]] = None,
                                                       if_: Optional[str] = None,
                                                       ignore_failure: Optional[bool] = None,
                                                       ignore_missing: Optional[bool] = None,
                                                       method: Optional[str] = None,
                                                       on_failures: Optional[Sequence[str]] = None,
                                                       salt: Optional[str] = None,
                                                       tag: Optional[str] = None,
                                                       target_field: Optional[str] = None,
                                                       opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorFingerprintResult
    def get_elasticsearch_ingest_processor_fingerprint_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,
                                                       method: Optional[pulumi.Input[str]] = None,
                                                       on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                                       salt: Optional[pulumi.Input[str]] = None,
                                                       tag: Optional[pulumi.Input[str]] = None,
                                                       target_field: Optional[pulumi.Input[str]] = None,
                                                       opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorFingerprintResult]
    func GetElasticsearchIngestProcessorFingerprint(ctx *Context, args *GetElasticsearchIngestProcessorFingerprintArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorFingerprintResult, error)
    func GetElasticsearchIngestProcessorFingerprintOutput(ctx *Context, args *GetElasticsearchIngestProcessorFingerprintOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorFingerprintResultOutput

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

    public static class GetElasticsearchIngestProcessorFingerprint 
    {
        public static Task<GetElasticsearchIngestProcessorFingerprintResult> InvokeAsync(GetElasticsearchIngestProcessorFingerprintArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorFingerprintResult> Invoke(GetElasticsearchIngestProcessorFingerprintInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorFingerprintResult> getElasticsearchIngestProcessorFingerprint(GetElasticsearchIngestProcessorFingerprintArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorFingerprintResult> getElasticsearchIngestProcessorFingerprint(GetElasticsearchIngestProcessorFingerprintArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorFingerprint:getElasticsearchIngestProcessorFingerprint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Fields List<string>
    Array of fields to include in the fingerprint.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    IgnoreMissing bool
    If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    Method string
    The hash method used to compute the fingerprint.
    OnFailures List<string>
    Handle failures for the processor.
    Salt string
    Salt value for the hash function.
    Tag string
    Identifier for the processor.
    TargetField string
    Output field for the fingerprint.
    Fields []string
    Array of fields to include in the fingerprint.
    Description string
    Description of the processor.
    If string
    Conditionally execute the processor
    IgnoreFailure bool
    Ignore failures for the processor.
    IgnoreMissing bool
    If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    Method string
    The hash method used to compute the fingerprint.
    OnFailures []string
    Handle failures for the processor.
    Salt string
    Salt value for the hash function.
    Tag string
    Identifier for the processor.
    TargetField string
    Output field for the fingerprint.
    fields List<String>
    Array of fields to include in the fingerprint.
    description String
    Description of the processor.
    if_ String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    ignoreMissing Boolean
    If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method String
    The hash method used to compute the fingerprint.
    onFailures List<String>
    Handle failures for the processor.
    salt String
    Salt value for the hash function.
    tag String
    Identifier for the processor.
    targetField String
    Output field for the fingerprint.
    fields string[]
    Array of fields to include in the fingerprint.
    description string
    Description of the processor.
    if string
    Conditionally execute the processor
    ignoreFailure boolean
    Ignore failures for the processor.
    ignoreMissing boolean
    If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method string
    The hash method used to compute the fingerprint.
    onFailures string[]
    Handle failures for the processor.
    salt string
    Salt value for the hash function.
    tag string
    Identifier for the processor.
    targetField string
    Output field for the fingerprint.
    fields Sequence[str]
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method str
    The hash method used to compute the fingerprint.
    on_failures Sequence[str]
    Handle failures for the processor.
    salt str
    Salt value for the hash function.
    tag str
    Identifier for the processor.
    target_field str
    Output field for the fingerprint.
    fields List<String>
    Array of fields to include in the fingerprint.
    description String
    Description of the processor.
    if String
    Conditionally execute the processor
    ignoreFailure Boolean
    Ignore failures for the processor.
    ignoreMissing Boolean
    If true, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method String
    The hash method used to compute the fingerprint.
    onFailures List<String>
    Handle failures for the processor.
    salt String
    Salt value for the hash function.
    tag String
    Identifier for the processor.
    targetField String
    Output field for the fingerprint.

    getElasticsearchIngestProcessorFingerprint Result

    The following output properties are available:

    Fields List<string>
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    Method string
    The hash method used to compute the fingerprint.
    OnFailures List<string>
    Handle failures for the processor.
    Salt string
    Salt value for the hash function.
    Tag string
    Identifier for the processor.
    TargetField string
    Output field for the fingerprint.
    Fields []string
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    Method string
    The hash method used to compute the fingerprint.
    OnFailures []string
    Handle failures for the processor.
    Salt string
    Salt value for the hash function.
    Tag string
    Identifier for the processor.
    TargetField string
    Output field for the fingerprint.
    fields List<String>
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method String
    The hash method used to compute the fingerprint.
    onFailures List<String>
    Handle failures for the processor.
    salt String
    Salt value for the hash function.
    tag String
    Identifier for the processor.
    targetField String
    Output field for the fingerprint.
    fields string[]
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method string
    The hash method used to compute the fingerprint.
    onFailures string[]
    Handle failures for the processor.
    salt string
    Salt value for the hash function.
    tag string
    Identifier for the processor.
    targetField string
    Output field for the fingerprint.
    fields Sequence[str]
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method str
    The hash method used to compute the fingerprint.
    on_failures Sequence[str]
    Handle failures for the processor.
    salt str
    Salt value for the hash function.
    tag str
    Identifier for the processor.
    target_field str
    Output field for the fingerprint.
    fields List<String>
    Array of fields to include in the fingerprint.
    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, the processor ignores any missing fields. If all fields are missing, the processor silently exits without modifying the document.
    method String
    The hash method used to compute the fingerprint.
    onFailures List<String>
    Handle failures for the processor.
    salt String
    Salt value for the hash function.
    tag String
    Identifier for the processor.
    targetField String
    Output field for the fingerprint.

    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