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

elasticstack.getElasticsearchEnrichPolicy

Explore with Pulumi AI

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

Returns information about an enrich policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html

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>
Copy
def get_elasticsearch_enrich_policy(name: Optional[str] = None,
                                    opts: Optional[InvokeOptions] = None) -> GetElasticsearchEnrichPolicyResult
def get_elasticsearch_enrich_policy_output(name: Optional[pulumi.Input[str]] = None,
                                    opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchEnrichPolicyResult]
Copy
func LookupElasticsearchEnrichPolicy(ctx *Context, args *LookupElasticsearchEnrichPolicyArgs, opts ...InvokeOption) (*LookupElasticsearchEnrichPolicyResult, error)
func LookupElasticsearchEnrichPolicyOutput(ctx *Context, args *LookupElasticsearchEnrichPolicyOutputArgs, opts ...InvokeOption) LookupElasticsearchEnrichPolicyResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetElasticsearchEnrichPolicyResult> getElasticsearchEnrichPolicy(GetElasticsearchEnrichPolicyArgs args, InvokeOptions options)
public static Output<GetElasticsearchEnrichPolicyResult> getElasticsearchEnrichPolicy(GetElasticsearchEnrichPolicyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: elasticstack:index/getElasticsearchEnrichPolicy:getElasticsearchEnrichPolicy
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
The name of the policy.
Name This property is required. string
The name of the policy.
name This property is required. String
The name of the policy.
name This property is required. string
The name of the policy.
name This property is required. str
The name of the policy.
name This property is required. String
The name of the policy.

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 in 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.
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 in 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.
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 in 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.
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 in 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.
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 in 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.
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 in 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.

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