1. Packages
  2. Opensearch Provider
  3. API Docs
  4. IngestPipeline
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project

opensearch.IngestPipeline

Explore with Pulumi AI

opensearch logo
opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project

    Provides an OpenSearch ingest pipeline resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as opensearch from "@pulumi/opensearch";
    
    // Create a simple ingest pipeline
    const test = new opensearch.IngestPipeline("test", {body: `{
      "description" : "describe pipeline",
      "version": 123,
      "processors" : [
        {
          "set" : {
            "field": "foo",
            "value": "bar"
          }
        }
      ]
    }
    
    `});
    
    import pulumi
    import pulumi_opensearch as opensearch
    
    # Create a simple ingest pipeline
    test = opensearch.IngestPipeline("test", body="""{
      "description" : "describe pipeline",
      "version": 123,
      "processors" : [
        {
          "set" : {
            "field": "foo",
            "value": "bar"
          }
        }
      ]
    }
    
    """)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opensearch/v2/opensearch"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Create a simple ingest pipeline
    		_, err := opensearch.NewIngestPipeline(ctx, "test", &opensearch.IngestPipelineArgs{
    			Body: pulumi.String(`{
      "description" : "describe pipeline",
      "version": 123,
      "processors" : [
        {
          "set" : {
            "field": "foo",
            "value": "bar"
          }
        }
      ]
    }
    
    `),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Opensearch = Pulumi.Opensearch;
    
    return await Deployment.RunAsync(() => 
    {
        // Create a simple ingest pipeline
        var test = new Opensearch.IngestPipeline("test", new()
        {
            Body = @"{
      ""description"" : ""describe pipeline"",
      ""version"": 123,
      ""processors"" : [
        {
          ""set"" : {
            ""field"": ""foo"",
            ""value"": ""bar""
          }
        }
      ]
    }
    
    ",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.opensearch.IngestPipeline;
    import com.pulumi.opensearch.IngestPipelineArgs;
    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) {
            // Create a simple ingest pipeline
            var test = new IngestPipeline("test", IngestPipelineArgs.builder()
                .body("""
    {
      "description" : "describe pipeline",
      "version": 123,
      "processors" : [
        {
          "set" : {
            "field": "foo",
            "value": "bar"
          }
        }
      ]
    }
    
                """)
                .build());
    
        }
    }
    
    resources:
      # Create a simple ingest pipeline
      test:
        type: opensearch:IngestPipeline
        properties:
          body: |+
            {
              "description" : "describe pipeline",
              "version": 123,
              "processors" : [
                {
                  "set" : {
                    "field": "foo",
                    "value": "bar"
                  }
                }
              ]
            }        
    

    Create IngestPipeline Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IngestPipeline(name: string, args: IngestPipelineArgs, opts?: CustomResourceOptions);
    @overload
    def IngestPipeline(resource_name: str,
                       args: IngestPipelineArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def IngestPipeline(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       body: Optional[str] = None,
                       ingest_pipeline_id: Optional[str] = None,
                       name: Optional[str] = None)
    func NewIngestPipeline(ctx *Context, name string, args IngestPipelineArgs, opts ...ResourceOption) (*IngestPipeline, error)
    public IngestPipeline(string name, IngestPipelineArgs args, CustomResourceOptions? opts = null)
    public IngestPipeline(String name, IngestPipelineArgs args)
    public IngestPipeline(String name, IngestPipelineArgs args, CustomResourceOptions options)
    
    type: opensearch:IngestPipeline
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args IngestPipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IngestPipelineArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IngestPipelineArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IngestPipelineArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IngestPipelineArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var ingestPipelineResource = new Opensearch.IngestPipeline("ingestPipelineResource", new()
    {
        Body = "string",
        IngestPipelineId = "string",
        Name = "string",
    });
    
    example, err := opensearch.NewIngestPipeline(ctx, "ingestPipelineResource", &opensearch.IngestPipelineArgs{
    	Body:             pulumi.String("string"),
    	IngestPipelineId: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    })
    
    var ingestPipelineResource = new IngestPipeline("ingestPipelineResource", IngestPipelineArgs.builder()
        .body("string")
        .ingestPipelineId("string")
        .name("string")
        .build());
    
    ingest_pipeline_resource = opensearch.IngestPipeline("ingestPipelineResource",
        body="string",
        ingest_pipeline_id="string",
        name="string")
    
    const ingestPipelineResource = new opensearch.IngestPipeline("ingestPipelineResource", {
        body: "string",
        ingestPipelineId: "string",
        name: "string",
    });
    
    type: opensearch:IngestPipeline
    properties:
        body: string
        ingestPipelineId: string
        name: string
    

    IngestPipeline Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IngestPipeline resource accepts the following input properties:

    Body string
    The JSON body of the ingest pipeline
    IngestPipelineId string
    The ID of this resource.
    Name string
    The name of the ingest pipeline
    Body string
    The JSON body of the ingest pipeline
    IngestPipelineId string
    The ID of this resource.
    Name string
    The name of the ingest pipeline
    body String
    The JSON body of the ingest pipeline
    ingestPipelineId String
    The ID of this resource.
    name String
    The name of the ingest pipeline
    body string
    The JSON body of the ingest pipeline
    ingestPipelineId string
    The ID of this resource.
    name string
    The name of the ingest pipeline
    body str
    The JSON body of the ingest pipeline
    ingest_pipeline_id str
    The ID of this resource.
    name str
    The name of the ingest pipeline
    body String
    The JSON body of the ingest pipeline
    ingestPipelineId String
    The ID of this resource.
    name String
    The name of the ingest pipeline

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IngestPipeline resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IngestPipeline Resource

    Get an existing IngestPipeline resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IngestPipelineState, opts?: CustomResourceOptions): IngestPipeline
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            body: Optional[str] = None,
            ingest_pipeline_id: Optional[str] = None,
            name: Optional[str] = None) -> IngestPipeline
    func GetIngestPipeline(ctx *Context, name string, id IDInput, state *IngestPipelineState, opts ...ResourceOption) (*IngestPipeline, error)
    public static IngestPipeline Get(string name, Input<string> id, IngestPipelineState? state, CustomResourceOptions? opts = null)
    public static IngestPipeline get(String name, Output<String> id, IngestPipelineState state, CustomResourceOptions options)
    resources:  _:    type: opensearch:IngestPipeline    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Body string
    The JSON body of the ingest pipeline
    IngestPipelineId string
    The ID of this resource.
    Name string
    The name of the ingest pipeline
    Body string
    The JSON body of the ingest pipeline
    IngestPipelineId string
    The ID of this resource.
    Name string
    The name of the ingest pipeline
    body String
    The JSON body of the ingest pipeline
    ingestPipelineId String
    The ID of this resource.
    name String
    The name of the ingest pipeline
    body string
    The JSON body of the ingest pipeline
    ingestPipelineId string
    The ID of this resource.
    name string
    The name of the ingest pipeline
    body str
    The JSON body of the ingest pipeline
    ingest_pipeline_id str
    The ID of this resource.
    name str
    The name of the ingest pipeline
    body String
    The JSON body of the ingest pipeline
    ingestPipelineId String
    The ID of this resource.
    name String
    The name of the ingest pipeline

    Import

    $ pulumi import opensearch:index/ingestPipeline:IngestPipeline test terraform-test
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    opensearch opensearch-project/terraform-provider-opensearch
    License
    Notes
    This Pulumi package is based on the opensearch Terraform Provider.
    opensearch logo
    opensearch 2.3.1 published on Monday, Apr 14, 2025 by opensearch-project