Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. getElasticsearchIngestProcessorScript
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elastic/terraform-provider-elasticstack

elasticstack.getElasticsearchIngestProcessorScript

Explore with Pulumi AI

elasticstack logo
elasticstack 0.11.15 published on Wednesday, Apr 23, 2025 by elastic
elastic/terraform-provider-elasticstack

    Runs an inline or stored script on incoming documents. The script runs in the ingest context.

    The script processor uses the script cache to avoid recompiling the script for each incoming document. To improve performance, ensure the script cache is properly sized before using a script processor in production.

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

    Using getElasticsearchIngestProcessorScript

    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 getElasticsearchIngestProcessorScript(args: GetElasticsearchIngestProcessorScriptArgs, opts?: InvokeOptions): Promise<GetElasticsearchIngestProcessorScriptResult>
function getElasticsearchIngestProcessorScriptOutput(args: GetElasticsearchIngestProcessorScriptOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchIngestProcessorScriptResult>
    def get_elasticsearch_ingest_processor_script(description: Optional[str] = None,
                                              if_: Optional[str] = None,
                                              ignore_failure: Optional[bool] = None,
                                              lang: Optional[str] = None,
                                              on_failures: Optional[Sequence[str]] = None,
                                              params: Optional[str] = None,
                                              script_id: Optional[str] = None,
                                              source: Optional[str] = None,
                                              tag: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetElasticsearchIngestProcessorScriptResult
def get_elasticsearch_ingest_processor_script_output(description: Optional[pulumi.Input[str]] = None,
                                              if_: Optional[pulumi.Input[str]] = None,
                                              ignore_failure: Optional[pulumi.Input[bool]] = None,
                                              lang: Optional[pulumi.Input[str]] = None,
                                              on_failures: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                              params: Optional[pulumi.Input[str]] = None,
                                              script_id: Optional[pulumi.Input[str]] = None,
                                              source: Optional[pulumi.Input[str]] = None,
                                              tag: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchIngestProcessorScriptResult]
    func GetElasticsearchIngestProcessorScript(ctx *Context, args *GetElasticsearchIngestProcessorScriptArgs, opts ...InvokeOption) (*GetElasticsearchIngestProcessorScriptResult, error)
func GetElasticsearchIngestProcessorScriptOutput(ctx *Context, args *GetElasticsearchIngestProcessorScriptOutputArgs, opts ...InvokeOption) GetElasticsearchIngestProcessorScriptResultOutput

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

    public static class GetElasticsearchIngestProcessorScript 
{
    public static Task<GetElasticsearchIngestProcessorScriptResult> InvokeAsync(GetElasticsearchIngestProcessorScriptArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchIngestProcessorScriptResult> Invoke(GetElasticsearchIngestProcessorScriptInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetElasticsearchIngestProcessorScriptResult> getElasticsearchIngestProcessorScript(GetElasticsearchIngestProcessorScriptArgs args, InvokeOptions options)
public static Output<GetElasticsearchIngestProcessorScriptResult> getElasticsearchIngestProcessorScript(GetElasticsearchIngestProcessorScriptArgs args, InvokeOptions options)

    fn::invoke:
  function: elasticstack:index/getElasticsearchIngestProcessorScript:getElasticsearchIngestProcessorScript
  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.
    Lang string
    Script language.
    OnFailures List<string>
    Handle failures for the processor.
    Params string
    Object containing parameters for the script.
    ScriptId string
    ID of a stored script. If no source is specified, this parameter is required.
    Source string
    Inline script. If no id is specified, this parameter is required.
    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.
    Lang string
    Script language.
    OnFailures []string
    Handle failures for the processor.
    Params string
    Object containing parameters for the script.
    ScriptId string
    ID of a stored script. If no source is specified, this parameter is required.
    Source string
    Inline script. If no id is specified, this parameter is required.
    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.
    lang String
    Script language.
    onFailures List<String>
    Handle failures for the processor.
    params String
    Object containing parameters for the script.
    scriptId String
    ID of a stored script. If no source is specified, this parameter is required.
    source String
    Inline script. If no id is specified, this parameter is required.
    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.
    lang string
    Script language.
    onFailures string[]
    Handle failures for the processor.
    params string
    Object containing parameters for the script.
    scriptId string
    ID of a stored script. If no source is specified, this parameter is required.
    source string
    Inline script. If no id is specified, this parameter is required.
    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.
    lang str
    Script language.
    on_failures Sequence[str]
    Handle failures for the processor.
    params str
    Object containing parameters for the script.
    script_id str
    ID of a stored script. If no source is specified, this parameter is required.
    source str
    Inline script. If no id is specified, this parameter is required.
    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.
    lang String
    Script language.
    onFailures List<String>
    Handle failures for the processor.
    params String
    Object containing parameters for the script.
    scriptId String
    ID of a stored script. If no source is specified, this parameter is required.
    source String
    Inline script. If no id is specified, this parameter is required.
    tag String
    Identifier for the processor.

    getElasticsearchIngestProcessorScript 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.
    Lang string
    Script language.
    OnFailures List<string>
    Handle failures for the processor.
    Params string
    Object containing parameters for the script.
    ScriptId string
    ID of a stored script. If no source is specified, this parameter is required.
    Source string
    Inline script. If no id is specified, this parameter is required.
    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.
    Lang string
    Script language.
    OnFailures []string
    Handle failures for the processor.
    Params string
    Object containing parameters for the script.
    ScriptId string
    ID of a stored script. If no source is specified, this parameter is required.
    Source string
    Inline script. If no id is specified, this parameter is required.
    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.
    lang String
    Script language.
    onFailures List<String>
    Handle failures for the processor.
    params String
    Object containing parameters for the script.
    scriptId String
    ID of a stored script. If no source is specified, this parameter is required.
    source String
    Inline script. If no id is specified, this parameter is required.
    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.
    lang string
    Script language.
    onFailures string[]
    Handle failures for the processor.
    params string
    Object containing parameters for the script.
    scriptId string
    ID of a stored script. If no source is specified, this parameter is required.
    source string
    Inline script. If no id is specified, this parameter is required.
    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.
    lang str
    Script language.
    on_failures Sequence[str]
    Handle failures for the processor.
    params str
    Object containing parameters for the script.
    script_id str
    ID of a stored script. If no source is specified, this parameter is required.
    source str
    Inline script. If no id is specified, this parameter is required.
    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.
    lang String
    Script language.
    onFailures List<String>
    Handle failures for the processor.
    params String
    Object containing parameters for the script.
    scriptId String
    ID of a stored script. If no source is specified, this parameter is required.
    source String
    Inline script. If no id is specified, this parameter is required.
    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
    elastic/terraform-provider-elasticstack