Skip to content

Commit c9c91d1

Browse files
Copilottobio
andcommitted
Regenerate documentation for enrich policy migration
Co-authored-by: tobio <[email protected]>
1 parent d208b65 commit c9c91d1

File tree

2 files changed

+32
-8
lines changed

2 files changed

+32
-8
lines changed

docs/data-sources/elasticsearch_enrich_policy.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,35 @@ output "query" {
7474

7575
- `name` (String) The name of the policy.
7676

77+
### Optional
78+
79+
- `elasticsearch_connection` (Block List, Deprecated) Elasticsearch connection configuration block. (see [below for nested schema](#nestedblock--elasticsearch_connection))
80+
7781
### Read-Only
7882

79-
- `enrich_fields` (Set of String) Fields to add to matching incoming documents. These fields must be present in the source indices.
83+
- `enrich_fields` (List of String) Fields to add to matching incoming documents. These fields must be present in the source indices.
8084
- `id` (String) Internal identifier of the resource
81-
- `indices` (Set of String) Array of one or more source indices used to create the enrich index.
82-
- `match_field` (String) Field in source indices used to match incoming documents.
85+
- `indices` (List of String) Array of one or more source indices used to create the enrich index.
86+
- `match_field` (String) Field from the source indices used to match incoming documents.
8387
- `policy_type` (String) The type of enrich policy, can be one of geo_match, match, range.
84-
- `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.
88+
- `query` (String) Query used to filter documents in the enrich index for matching.
89+
90+
<a id="nestedblock--elasticsearch_connection"></a>
91+
### Nested Schema for `elasticsearch_connection`
92+
93+
Optional:
94+
95+
- `api_key` (String, Sensitive) API Key to use for authentication to Elasticsearch
96+
- `bearer_token` (String, Sensitive) Bearer Token to use for authentication to Elasticsearch
97+
- `ca_data` (String) PEM-encoded custom Certificate Authority certificate
98+
- `ca_file` (String) Path to a custom Certificate Authority certificate
99+
- `cert_data` (String) PEM encoded certificate for client auth
100+
- `cert_file` (String) Path to a file containing the PEM encoded certificate for client auth
101+
- `endpoints` (List of String, Sensitive) A list of endpoints where the terraform provider will point to, this must include the http(s) schema and port number.
102+
- `es_client_authentication` (String, Sensitive) ES Client Authentication field to be used with the JWT token
103+
- `headers` (Map of String, Sensitive) A list of headers to be sent with each request to Elasticsearch.
104+
- `insecure` (Boolean) Disable TLS certificate validation
105+
- `key_data` (String, Sensitive) PEM encoded private key for client auth
106+
- `key_file` (String) Path to a file containing the PEM encoded private key for client auth
107+
- `password` (String, Sensitive) Password to use for API authentication to Elasticsearch.
108+
- `username` (String) Username to use for API authentication to Elasticsearch.

docs/resources/elasticsearch_enrich_policy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,21 +50,21 @@ resource "elasticstack_elasticsearch_enrich_policy" "policy1" {
5050

5151
### Required
5252

53-
- `enrich_fields` (Set of String) Fields to add to matching incoming documents. These fields must be present in the source indices.
54-
- `indices` (Set of String) Array of one or more source indices used to create the enrich index.
53+
- `enrich_fields` (List of String) Fields to add to matching incoming documents. These fields must be present in the source indices.
54+
- `indices` (List of String) Array of one or more source indices used to create the enrich index.
5555
- `match_field` (String) Field in source indices used to match incoming documents.
5656
- `name` (String) Name of the enrich policy to manage.
5757
- `policy_type` (String) The type of enrich policy, can be one of geo_match, match, range.
5858

5959
### Optional
6060

61-
- `elasticsearch_connection` (Block List, Max: 1, Deprecated) Elasticsearch connection configuration block. This property will be removed in a future provider version. Configure the Elasticsearch connection via the provider configuration instead. (see [below for nested schema](#nestedblock--elasticsearch_connection))
61+
- `elasticsearch_connection` (Block List, Deprecated) Elasticsearch connection configuration block. (see [below for nested schema](#nestedblock--elasticsearch_connection))
6262
- `execute` (Boolean) Whether to call the execute API function in order to create the enrich index.
6363
- `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.
6464

6565
### Read-Only
6666

67-
- `id` (String) The ID of this resource.
67+
- `id` (String) Internal identifier of the resource
6868

6969
<a id="nestedblock--elasticsearch_connection"></a>
7070
### Nested Schema for `elasticsearch_connection`

0 commit comments

Comments
 (0)