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

elasticstack.getElasticsearchIngestProcessorRename

Explore with Pulumi AI

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

    Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown.

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as elasticstack from "@pulumi/elasticstack";
    
    const rename = elasticstack.getElasticsearchIngestProcessorRename({
        field: "provider",
        targetField: "cloud.provider",
    });
    const myIngestPipeline = new elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", {processors: [rename.then(rename => rename.json)]});
    
    import pulumi
    import pulumi_elasticstack as elasticstack
    
    rename = elasticstack.get_elasticsearch_ingest_processor_rename(field="provider",
        target_field="cloud.provider")
    my_ingest_pipeline = elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", processors=[rename.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 {
    		rename, err := elasticstack.GetElasticsearchIngestProcessorRename(ctx, &elasticstack.GetElasticsearchIngestProcessorRenameArgs{
    			Field:       "provider",
    			TargetField: "cloud.provider",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = elasticstack.NewElasticsearchIngestPipeline(ctx, "myIngestPipeline", &elasticstack.ElasticsearchIngestPipelineArgs{
    			Processors: pulumi.StringArray{
    				pulumi.String(rename.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 rename = Elasticstack.GetElasticsearchIngestProcessorRename.Invoke(new()
        {
            Field = "provider",
            TargetField = "cloud.provider",
        });
    
        var myIngestPipeline = new Elasticstack.ElasticsearchIngestPipeline("myIngestPipeline", new()
        {
            Processors = new[]
            {
                rename.Apply(getElasticsearchIngestProcessorRenameResult => getElasticsearchIngestProcessorRenameResult.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.GetElasticsearchIngestProcessorRenameArgs;
    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 rename = ElasticstackFunctions.getElasticsearchIngestProcessorRename(GetElasticsearchIngestProcessorRenameArgs.builder()
                .field("provider")
                .targetField("cloud.provider")
                .build());
    
            var myIngestPipeline = new ElasticsearchIngestPipeline("myIngestPipeline", ElasticsearchIngestPipelineArgs.builder()
                .processors(rename.applyValue(getElasticsearchIngestProcessorRenameResult -> getElasticsearchIngestProcessorRenameResult.json()))
                .build());
    
        }
    }
    
    resources:
      myIngestPipeline:
        type: elasticstack:ElasticsearchIngestPipeline
        properties:
          processors:
            - ${rename.json}
    variables:
      rename:
        fn::invoke:
          function: elasticstack:getElasticsearchIngestProcessorRename
          arguments:
            field: provider
            targetField: cloud.provider
    

    Using getElasticsearchIngestProcessorRename

    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 getElasticsearchIngestProcessorRename(args: GetElasticsearchIngestProcessorRenameArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorRenameResult>
    function getElasticsearchIngestProcessorRenameOutput(args: GetElasticsearchIngestProcessorRenameOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorRenameResult>
    def get_elasticsearch_ingest_processor_rename(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,
                                                  tag: Optional[str] = None,
                                                  target_field: Optional[str] = None,
                                                  opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorRenameResult
    def get_elasticsearch_ingest_processor_rename_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,
                                                  tag: Optional[pulumi.Input[str]] = None,
                                                  target_field: Optional[pulumi.Input[str]] = None,
                                                  opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorRenameResult]
    func GetElasticsearchIngestProcessorRename(ctx *Context, args *GetElasticsearchIngestProcessorRenameArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorRenameResult, error)
    func GetElasticsearchIngestProcessorRenameOutput(ctx *Context, args *GetElasticsearchIngestProcessorRenameOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorRenameResultOutput

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

    public static class GetElasticsearchIngestProcessorRename 
    {
        public static Task<GetElasticsearchIngestProcessorRenameResult> InvokeAsync(GetElasticsearchIngestProcessorRenameArgs args, InvokeOptions? opts = null)
        public static Output<GetElasticsearchIngestProcessorRenameResult> Invoke(GetElasticsearchIngestProcessorRenameInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetElasticsearchIngestProcessorRenameResult> getElasticsearchIngestProcessorRename(GetElasticsearchIngestProcessorRenameArgs args, InvokeOptions options)
    public static Output<GetElasticsearchIngestProcessorRenameResult> getElasticsearchIngestProcessorRename(GetElasticsearchIngestProcessorRenameArgs args, InvokeOptions options)
    
    fn::invoke:
      function: elasticstack:index/getElasticsearchIngestProcessorRename:getElasticsearchIngestProcessorRename
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Field string
    The field to be renamed.
    TargetField string
    The new name of the field.
    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.
    Field string
    The field to be renamed.
    TargetField string
    The new name of the field.
    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.
    field String
    The field to be renamed.
    targetField String
    The new name of the field.
    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.
    field string
    The field to be renamed.
    targetField string
    The new name of the field.
    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.
    field str
    The field to be renamed.
    target_field str
    The new name of the field.
    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.
    field String
    The field to be renamed.
    targetField String
    The new name of the field.
    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.

    getElasticsearchIngestProcessorRename Result

    The following output properties are available:

    Field string
    The field to be renamed.
    Id string
    Internal identifier of the resource.
    Json string
    JSON representation of this data source.
    TargetField string
    The new name of the field.
    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.
    Field string
    The field to be renamed.
    Id string
    Internal identifier of the resource.
    Json string
    JSON representation of this data source.
    TargetField string
    The new name of the field.
    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.
    field String
    The field to be renamed.
    id String
    Internal identifier of the resource.
    json String
    JSON representation of this data source.
    targetField String
    The new name of the field.
    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.
    field string
    The field to be renamed.
    id string
    Internal identifier of the resource.
    json string
    JSON representation of this data source.
    targetField string
    The new name of the field.
    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.
    field str
    The field to be renamed.
    id str
    Internal identifier of the resource.
    json str
    JSON representation of this data source.
    target_field str
    The new name of the field.
    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.
    field String
    The field to be renamed.
    id String
    Internal identifier of the resource.
    json String
    JSON representation of this data source.
    targetField String
    The new name of the field.
    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