elasticstack.getElasticsearchEnrichPolicy

elasticstack 0.12.1 published on Thursday, Oct 23, 2025 by elastic

Using getElasticsearchEnrichPolicy

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 getElasticsearchEnrichPolicy(args: GetElasticsearchEnrichPolicyArgs, opts?: InvokeOptions): Promise<GetElasticsearchEnrichPolicyResult>
function getElasticsearchEnrichPolicyOutput(args: GetElasticsearchEnrichPolicyOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchEnrichPolicyResult>

def get_elasticsearch_enrich_policy(elasticsearch_connections: Optional[Sequence[GetElasticsearchEnrichPolicyElasticsearchConnection]] = None,
                                    name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetElasticsearchEnrichPolicyResult
def get_elasticsearch_enrich_policy_output(elasticsearch_connections: Optional[pulumi.Input[Sequence[pulumi.Input[GetElasticsearchEnrichPolicyElasticsearchConnectionArgs]]]] = None,
                                    name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchEnrichPolicyResult]

func LookupElasticsearchEnrichPolicy(ctx *Context, args *LookupElasticsearchEnrichPolicyArgs, opts ...InvokeOption) (*LookupElasticsearchEnrichPolicyResult, error)
func LookupElasticsearchEnrichPolicyOutput(ctx *Context, args *LookupElasticsearchEnrichPolicyOutputArgs, opts ...InvokeOption) LookupElasticsearchEnrichPolicyResultOutput

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

public static class GetElasticsearchEnrichPolicy 
{
    public static Task<GetElasticsearchEnrichPolicyResult> InvokeAsync(GetElasticsearchEnrichPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchEnrichPolicyResult> Invoke(GetElasticsearchEnrichPolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetElasticsearchEnrichPolicyResult> getElasticsearchEnrichPolicy(GetElasticsearchEnrichPolicyArgs args, InvokeOptions options)
public static Output<GetElasticsearchEnrichPolicyResult> getElasticsearchEnrichPolicy(GetElasticsearchEnrichPolicyArgs args, InvokeOptions options)

fn::invoke:
  function: elasticstack:index/getElasticsearchEnrichPolicy:getElasticsearchEnrichPolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the policy.
ElasticsearchConnections List<GetElasticsearchEnrichPolicyElasticsearchConnection>: Elasticsearch connection configuration block.
Deprecated: Deprecated

Name string: The name of the policy.
ElasticsearchConnections []GetElasticsearchEnrichPolicyElasticsearchConnection: Elasticsearch connection configuration block.
Deprecated: Deprecated

name String: The name of the policy.
elasticsearchConnections List<GetElasticsearchEnrichPolicyElasticsearchConnection>: Elasticsearch connection configuration block.
Deprecated: Deprecated

name string: The name of the policy.
elasticsearchConnections GetElasticsearchEnrichPolicyElasticsearchConnection[]: Elasticsearch connection configuration block.
Deprecated: Deprecated

name str: The name of the policy.
elasticsearch_connections Sequence[GetElasticsearchEnrichPolicyElasticsearchConnection]: Elasticsearch connection configuration block.
Deprecated: Deprecated

name String: The name of the policy.
elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.
Deprecated: Deprecated

getElasticsearchEnrichPolicy Result

The following output properties are available:

EnrichFields List<string>: Fields to add to matching incoming documents. These fields must be present in the source indices.
Id string: Internal identifier of the resource
Indices List<string>: Array of one or more source indices used to create the enrich index.
MatchField string: Field from the source indices used to match incoming documents.
Name string: The name of the policy.
PolicyType string: The type of enrich policy, can be one of geo_match, match, range.
Query string: Query used to filter documents in the enrich index. The policy only uses documents matching this query to enrich incoming documents. Defaults to a match_all query.
ElasticsearchConnections List<GetElasticsearchEnrichPolicyElasticsearchConnection>: Elasticsearch connection configuration block.
Deprecated: Deprecated

EnrichFields []string: Fields to add to matching incoming documents. These fields must be present in the source indices.
Id string: Internal identifier of the resource
Indices []string: Array of one or more source indices used to create the enrich index.
MatchField string: Field from the source indices used to match incoming documents.
Name string: The name of the policy.
PolicyType string: The type of enrich policy, can be one of geo_match, match, range.
Query string: Query used to filter documents in the enrich index. The policy only uses documents matching this query to enrich incoming documents. Defaults to a match_all query.
ElasticsearchConnections []GetElasticsearchEnrichPolicyElasticsearchConnection: Elasticsearch connection configuration block.
Deprecated: Deprecated

enrichFields List<String>: Fields to add to matching incoming documents. These fields must be present in the source indices.
id String: Internal identifier of the resource
indices List<String>: Array of one or more source indices used to create the enrich index.
matchField String: Field from the source indices used to match incoming documents.
name String: The name of the policy.
policyType String: The type of enrich policy, can be one of geo_match, match, range.
query String: Query used to filter documents in the enrich index. The policy only uses documents matching this query to enrich incoming documents. Defaults to a match_all query.
elasticsearchConnections List<GetElasticsearchEnrichPolicyElasticsearchConnection>: Elasticsearch connection configuration block.
Deprecated: Deprecated

enrichFields string[]: Fields to add to matching incoming documents. These fields must be present in the source indices.
id string: Internal identifier of the resource
indices string[]: Array of one or more source indices used to create the enrich index.
matchField string: Field from the source indices used to match incoming documents.
name string: The name of the policy.
policyType string: The type of enrich policy, can be one of geo_match, match, range.
query string: Query used to filter documents in the enrich index. The policy only uses documents matching this query to enrich incoming documents. Defaults to a match_all query.
elasticsearchConnections GetElasticsearchEnrichPolicyElasticsearchConnection[]: Elasticsearch connection configuration block.
Deprecated: Deprecated

enrich_fields Sequence[str]: Fields to add to matching incoming documents. These fields must be present in the source indices.
id str: Internal identifier of the resource
indices Sequence[str]: Array of one or more source indices used to create the enrich index.
match_field str: Field from the source indices used to match incoming documents.
name str: The name of the policy.
policy_type str: The type of enrich policy, can be one of geo_match, match, range.
query str: Query used to filter documents in the enrich index. The policy only uses documents matching this query to enrich incoming documents. Defaults to a match_all query.
elasticsearch_connections Sequence[GetElasticsearchEnrichPolicyElasticsearchConnection]: Elasticsearch connection configuration block.
Deprecated: Deprecated

enrichFields List<String>: Fields to add to matching incoming documents. These fields must be present in the source indices.
id String: Internal identifier of the resource
indices List<String>: Array of one or more source indices used to create the enrich index.
matchField String: Field from the source indices used to match incoming documents.
name String: The name of the policy.
policyType String: The type of enrich policy, can be one of geo_match, match, range.
query String: Query used to filter documents in the enrich index. The policy only uses documents matching this query to enrich incoming documents. Defaults to a match_all query.
elasticsearchConnections List<Property Map>: Elasticsearch connection configuration block.
Deprecated: Deprecated

Supporting Types

GetElasticsearchEnrichPolicyElasticsearchConnection

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
Headers Dictionary<string, string>: A list of headers to be sent with each request to Elasticsearch.
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
Headers map[string]string: A list of headers to be sent with each request to Elasticsearch.
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
headers Map<String,String>: A list of headers to be sent with each request to Elasticsearch.
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
headers {[key: string]: string}: A list of headers to be sent with each request to Elasticsearch.
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
headers Mapping[str, str]: A list of headers to be sent with each request to Elasticsearch.
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
headers Map<String>: A list of headers to be sent with each request to Elasticsearch.
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.12.1 published on Thursday, Oct 23, 2025 by elastic

elastic/terraform-provider-elasticstack

elasticstack.getElasticsearchEnrichPolicy

On this page

On this page

Using getElasticsearchEnrichPolicy

getElasticsearchEnrichPolicy Result

Supporting Types

GetElasticsearchEnrichPolicyElasticsearchConnection

Package Details

On this page

On this page