Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Elasticstack Provider
  3. API Docs
  4. ElasticsearchIngestPipeline
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic
elastic/terraform-provider-elasticstack

elasticstack.ElasticsearchIngestPipeline

Explore with Pulumi AI

elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic
elastic/terraform-provider-elasticstack

Import

$ pulumi import elasticstack:index/elasticsearchIngestPipeline:ElasticsearchIngestPipeline my_ingest_pipeline <cluster_uuid>/<ingest pipeline name>
Copy

Create ElasticsearchIngestPipeline Resource

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

Constructor syntax

new ElasticsearchIngestPipeline(name: string, args: ElasticsearchIngestPipelineArgs, opts?: CustomResourceOptions);
@overload
def ElasticsearchIngestPipeline(resource_name: str,
                                args: ElasticsearchIngestPipelineArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def ElasticsearchIngestPipeline(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                processors: Optional[Sequence[str]] = None,
                                description: Optional[str] = None,
                                elasticsearch_connection: Optional[ElasticsearchIngestPipelineElasticsearchConnectionArgs] = None,
                                metadata: Optional[str] = None,
                                name: Optional[str] = None,
                                on_failures: Optional[Sequence[str]] = None)
func NewElasticsearchIngestPipeline(ctx *Context, name string, args ElasticsearchIngestPipelineArgs, opts ...ResourceOption) (*ElasticsearchIngestPipeline, error)
public ElasticsearchIngestPipeline(string name, ElasticsearchIngestPipelineArgs args, CustomResourceOptions? opts = null)
public ElasticsearchIngestPipeline(String name, ElasticsearchIngestPipelineArgs args)
public ElasticsearchIngestPipeline(String name, ElasticsearchIngestPipelineArgs args, CustomResourceOptions options)

type: elasticstack:ElasticsearchIngestPipeline
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ElasticsearchIngestPipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ElasticsearchIngestPipelineArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ElasticsearchIngestPipelineArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ElasticsearchIngestPipelineArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ElasticsearchIngestPipelineArgs
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 elasticsearchIngestPipelineResource = new Elasticstack.ElasticsearchIngestPipeline("elasticsearchIngestPipelineResource", new()
{
    Processors = new[]
    {
        "string",
    },
    Description = "string",
    Metadata = "string",
    Name = "string",
    OnFailures = new[]
    {
        "string",
    },
});
Copy
example, err := elasticstack.NewElasticsearchIngestPipeline(ctx, "elasticsearchIngestPipelineResource", &elasticstack.ElasticsearchIngestPipelineArgs{
Processors: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
Metadata: pulumi.String("string"),
Name: pulumi.String("string"),
OnFailures: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var elasticsearchIngestPipelineResource = new ElasticsearchIngestPipeline("elasticsearchIngestPipelineResource", ElasticsearchIngestPipelineArgs.builder()
    .processors("string")
    .description("string")
    .metadata("string")
    .name("string")
    .onFailures("string")
    .build());
Copy
elasticsearch_ingest_pipeline_resource = elasticstack.ElasticsearchIngestPipeline("elasticsearchIngestPipelineResource",
    processors=["string"],
    description="string",
    metadata="string",
    name="string",
    on_failures=["string"])
Copy
const elasticsearchIngestPipelineResource = new elasticstack.ElasticsearchIngestPipeline("elasticsearchIngestPipelineResource", {
    processors: ["string"],
    description: "string",
    metadata: "string",
    name: "string",
    onFailures: ["string"],
});
Copy
type: elasticstack:ElasticsearchIngestPipeline
properties:
    description: string
    metadata: string
    name: string
    onFailures:
        - string
    processors:
        - string
Copy

ElasticsearchIngestPipeline 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 ElasticsearchIngestPipeline resource accepts the following input properties:

Processors This property is required. List<string>
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
Description string
Description of the ingest pipeline.
ElasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnection
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

Metadata string
Optional user metadata about the index template.
Name string
The name of the ingest pipeline.
OnFailures List<string>
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
Processors This property is required. []string
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
Description string
Description of the ingest pipeline.
ElasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnectionArgs
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

Metadata string
Optional user metadata about the index template.
Name string
The name of the ingest pipeline.
OnFailures []string
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors This property is required. List<String>
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description String
Description of the ingest pipeline.
elasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnection
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata String
Optional user metadata about the index template.
name String
The name of the ingest pipeline.
onFailures List<String>
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors This property is required. string[]
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description string
Description of the ingest pipeline.
elasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnection
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata string
Optional user metadata about the index template.
name string
The name of the ingest pipeline.
onFailures string[]
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors This property is required. Sequence[str]
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description str
Description of the ingest pipeline.
elasticsearch_connection ElasticsearchIngestPipelineElasticsearchConnectionArgs
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata str
Optional user metadata about the index template.
name str
The name of the ingest pipeline.
on_failures Sequence[str]
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors This property is required. List<String>
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description String
Description of the ingest pipeline.
elasticsearchConnection Property Map
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata String
Optional user metadata about the index template.
name String
The name of the ingest pipeline.
onFailures List<String>
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document

Outputs

All input properties are implicitly available as output properties. Additionally, the ElasticsearchIngestPipeline 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 ElasticsearchIngestPipeline Resource

Get an existing ElasticsearchIngestPipeline 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?: ElasticsearchIngestPipelineState, opts?: CustomResourceOptions): ElasticsearchIngestPipeline
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        elasticsearch_connection: Optional[ElasticsearchIngestPipelineElasticsearchConnectionArgs] = None,
        metadata: Optional[str] = None,
        name: Optional[str] = None,
        on_failures: Optional[Sequence[str]] = None,
        processors: Optional[Sequence[str]] = None) -> ElasticsearchIngestPipeline
func GetElasticsearchIngestPipeline(ctx *Context, name string, id IDInput, state *ElasticsearchIngestPipelineState, opts ...ResourceOption) (*ElasticsearchIngestPipeline, error)
public static ElasticsearchIngestPipeline Get(string name, Input<string> id, ElasticsearchIngestPipelineState? state, CustomResourceOptions? opts = null)
public static ElasticsearchIngestPipeline get(String name, Output<String> id, ElasticsearchIngestPipelineState state, CustomResourceOptions options)
resources:  _:    type: elasticstack:ElasticsearchIngestPipeline    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Description of the ingest pipeline.
ElasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnection
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

Metadata string
Optional user metadata about the index template.
Name string
The name of the ingest pipeline.
OnFailures List<string>
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
Processors List<string>
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
Description string
Description of the ingest pipeline.
ElasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnectionArgs
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

Metadata string
Optional user metadata about the index template.
Name string
The name of the ingest pipeline.
OnFailures []string
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
Processors []string
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description String
Description of the ingest pipeline.
elasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnection
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata String
Optional user metadata about the index template.
name String
The name of the ingest pipeline.
onFailures List<String>
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors List<String>
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description string
Description of the ingest pipeline.
elasticsearchConnection ElasticsearchIngestPipelineElasticsearchConnection
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata string
Optional user metadata about the index template.
name string
The name of the ingest pipeline.
onFailures string[]
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors string[]
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description str
Description of the ingest pipeline.
elasticsearch_connection ElasticsearchIngestPipelineElasticsearchConnectionArgs
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata str
Optional user metadata about the index template.
name str
The name of the ingest pipeline.
on_failures Sequence[str]
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors Sequence[str]
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.
description String
Description of the ingest pipeline.
elasticsearchConnection Property Map
Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead.

Deprecated: Deprecated

metadata String
Optional user metadata about the index template.
name String
The name of the ingest pipeline.
onFailures List<String>
Processors to run immediately after a processor failure. Each processor supports a processor-level on_failure value. If a processor without an on_failure value fails, Elasticsearch uses this pipeline-level parameter as a fallback. The processors in this parameter run sequentially in the order specified. Elasticsearch will not attempt to run the pipeline’s remaining processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document
processors List<String>
Processors used to perform transformations on documents before indexing. Processors run sequentially in the order specified. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/processors.html. Each record must be a valid JSON document.

Supporting Types

ElasticsearchIngestPipelineElasticsearchConnection
, ElasticsearchIngestPipelineElasticsearchConnectionArgs

ApiKey string
API Key to use for authentication to Elasticsearch
BearerToken string
Bearer Token to use for authentication to Elasticsearch
CaData string
PEM-encoded custom Certificate Authority certificate
CaFile string
Path to a custom Certificate Authority certificate
CertData string
PEM encoded certificate for client auth
CertFile string
Path to a file containing the PEM encoded certificate for client auth
Endpoints List<string>
EsClientAuthentication string
ES Client Authentication field to be used with the JWT token
Insecure bool
Disable TLS certificate validation
KeyData string
PEM encoded private key for client auth
KeyFile string
Path to a file containing the PEM encoded private key for client auth
Password string
Password to use for API authentication to Elasticsearch.
Username string
Username to use for API authentication to Elasticsearch.
ApiKey string
API Key to use for authentication to Elasticsearch
BearerToken string
Bearer Token to use for authentication to Elasticsearch
CaData string
PEM-encoded custom Certificate Authority certificate
CaFile string
Path to a custom Certificate Authority certificate
CertData string
PEM encoded certificate for client auth
CertFile string
Path to a file containing the PEM encoded certificate for client auth
Endpoints []string
EsClientAuthentication string
ES Client Authentication field to be used with the JWT token
Insecure bool
Disable TLS certificate validation
KeyData string
PEM encoded private key for client auth
KeyFile string
Path to a file containing the PEM encoded private key for client auth
Password string
Password to use for API authentication to Elasticsearch.
Username string
Username to use for API authentication to Elasticsearch.
apiKey String
API Key to use for authentication to Elasticsearch
bearerToken String
Bearer Token to use for authentication to Elasticsearch
caData String
PEM-encoded custom Certificate Authority certificate
caFile String
Path to a custom Certificate Authority certificate
certData String
PEM encoded certificate for client auth
certFile String
Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String
ES Client Authentication field to be used with the JWT token
insecure Boolean
Disable TLS certificate validation
keyData String
PEM encoded private key for client auth
keyFile String
Path to a file containing the PEM encoded private key for client auth
password String
Password to use for API authentication to Elasticsearch.
username String
Username to use for API authentication to Elasticsearch.
apiKey string
API Key to use for authentication to Elasticsearch
bearerToken string
Bearer Token to use for authentication to Elasticsearch
caData string
PEM-encoded custom Certificate Authority certificate
caFile string
Path to a custom Certificate Authority certificate
certData string
PEM encoded certificate for client auth
certFile string
Path to a file containing the PEM encoded certificate for client auth
endpoints string[]
esClientAuthentication string
ES Client Authentication field to be used with the JWT token
insecure boolean
Disable TLS certificate validation
keyData string
PEM encoded private key for client auth
keyFile string
Path to a file containing the PEM encoded private key for client auth
password string
Password to use for API authentication to Elasticsearch.
username string
Username to use for API authentication to Elasticsearch.
api_key str
API Key to use for authentication to Elasticsearch
bearer_token str
Bearer Token to use for authentication to Elasticsearch
ca_data str
PEM-encoded custom Certificate Authority certificate
ca_file str
Path to a custom Certificate Authority certificate
cert_data str
PEM encoded certificate for client auth
cert_file str
Path to a file containing the PEM encoded certificate for client auth
endpoints Sequence[str]
es_client_authentication str
ES Client Authentication field to be used with the JWT token
insecure bool
Disable TLS certificate validation
key_data str
PEM encoded private key for client auth
key_file str
Path to a file containing the PEM encoded private key for client auth
password str
Password to use for API authentication to Elasticsearch.
username str
Username to use for API authentication to Elasticsearch.
apiKey String
API Key to use for authentication to Elasticsearch
bearerToken String
Bearer Token to use for authentication to Elasticsearch
caData String
PEM-encoded custom Certificate Authority certificate
caFile String
Path to a custom Certificate Authority certificate
certData String
PEM encoded certificate for client auth
certFile String
Path to a file containing the PEM encoded certificate for client auth
endpoints List<String>
esClientAuthentication String
ES Client Authentication field to be used with the JWT token
insecure Boolean
Disable TLS certificate validation
keyData String
PEM encoded private key for client auth
keyFile String
Path to a file containing the PEM encoded private key for client auth
password String
Password to use for API authentication to Elasticsearch.
username String
Username to use for API authentication to Elasticsearch.

Package Details

Repository
elasticstack elastic/terraform-provider-elasticstack
License
Notes
This Pulumi package is based on the elasticstack Terraform Provider.
elasticstack 0.11.14 published on Monday, Apr 14, 2025 by elastic
elastic/terraform-provider-elasticstack