diff --git a/Makefile b/Makefile index bac041a4c..d94bcf925 100644 --- a/Makefile +++ b/Makefile @@ -225,7 +225,7 @@ docker-clean: ## Try to remove provisioned nodes and assigned network .PHONY: docs-generate docs-generate: tools ## Generate documentation for the provider - @ go tool github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name elasticstack + @ go tool github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs generate --provider-name terraform-provider-elasticstack .PHONY: gen diff --git a/docs/data-sources/elasticsearch_enrich_policy.md b/docs/data-sources/elasticsearch_enrich_policy.md index 9c286ae92..b28cc69ad 100644 --- a/docs/data-sources/elasticsearch_enrich_policy.md +++ b/docs/data-sources/elasticsearch_enrich_policy.md @@ -1,13 +1,15 @@ + --- -subcategory: "Enrich" +# generated by https://github.com/hashicorp/terraform-plugin-docs page_title: "elasticstack_elasticsearch_enrich_policy Data Source - terraform-provider-elasticstack" +subcategory: "Enrich" description: |- - Returns information about an enrich policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html + Returns information about an enrich policy. See the enrich policy API documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html for more details. --- -# Data Source: elasticstack_elasticsearch_enrich_policy +# elasticstack_elasticsearch_enrich_policy (Data Source) -Returns information about an enrich policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html +Returns information about an enrich policy. See the [enrich policy API documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_index_template.md b/docs/data-sources/elasticsearch_index_template.md index 9beebbb90..da0da4488 100644 --- a/docs/data-sources/elasticsearch_index_template.md +++ b/docs/data-sources/elasticsearch_index_template.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_index_template Data Source - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_index_template Data Source" description: |- - Retrieves index template. + Retrieves information about an existing index template definition. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html --- -# Data Source: elasticstack_elasticsearch_index_template +# elasticstack_elasticsearch_index_template (Data Source) -Use this data source to retrieve information about existing Elasticsearch index templates. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html +Retrieves information about an existing index template definition. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_indices.md b/docs/data-sources/elasticsearch_indices.md index 36ad08c9d..1a0fdb5f4 100644 --- a/docs/data-sources/elasticsearch_indices.md +++ b/docs/data-sources/elasticsearch_indices.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_indices Data Source - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_indices Data Source" description: |- - Retrieves indices. + Retrieves information about existing Elasticsearch indices. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html --- -# Data Source: elasticstack_elasticsearch_indices +# elasticstack_elasticsearch_indices (Data Source) -Use this data source to retrieve and get information about existing Elasticsearch indices. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html +Retrieves information about existing Elasticsearch indices. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_info.md b/docs/data-sources/elasticsearch_info.md index 2ea14d1d8..1545d9c1b 100644 --- a/docs/data-sources/elasticsearch_info.md +++ b/docs/data-sources/elasticsearch_info.md @@ -1,14 +1,15 @@ + --- -subcategory: "Cluster" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_info Data Source" +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_info Data Source - terraform-provider-elasticstack" +subcategory: "Elasticsearch" description: |- - Gets information about the Elasticsearch cluster. + Gets information about the Elastic cluster. --- -# Data Source: elasticstack_elasticsearch_info +# elasticstack_elasticsearch_info (Data Source) -This data source provides the information about the configured Elasticsearch cluster +Gets information about the Elastic cluster. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_append.md b/docs/data-sources/elasticsearch_ingest_processor_append.md index f33f66eb2..da6750d1e 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_append.md +++ b/docs/data-sources/elasticsearch_ingest_processor_append.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_append Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_append Data Source" description: |- - Helper data source to create a processor which appends one or more values to an existing array if the field already exists and it is an array. + Helper data source which can be used to create the configuration for an append processor. This processor appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. See the append processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_append - -Helper data source to which can be used to create a processor to append one or more values to an existing array if the field already exists and it is an array. -Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. +# elasticstack_elasticsearch_ingest_processor_append (Data Source) -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html +Helper data source which can be used to create the configuration for an append processor. This processor appends one or more values to an existing array if the field already exists and it is an array. Converts a scalar to an array and appends one or more values to it if the field exists and it is a scalar. Creates an array containing the provided values if the field doesn’t exist. See the [append processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/append-processor.html) for more details. ## Example Usage @@ -56,4 +54,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { - `id` (String) Internal identifier of the resource - `json` (String) JSON representation of this data source. - diff --git a/docs/data-sources/elasticsearch_ingest_processor_bytes.md b/docs/data-sources/elasticsearch_ingest_processor_bytes.md index 692f8b225..4f7b5782e 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_bytes.md +++ b/docs/data-sources/elasticsearch_ingest_processor_bytes.md @@ -1,18 +1,21 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_bytes Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_bytes Data Source" description: |- - Helper data source to create a processor which converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). + Helper data source which can be used to create the configuration for a bytes processor. The processor converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). See the bytes processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html for more details. + If the field is an array of strings, all members of the array will be converted. + Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_bytes +# elasticstack_elasticsearch_ingest_processor_bytes (Data Source) -Helper data source to which can be used to create a processor to convert a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). If the field is an array of strings, all members of the array will be converted. +Helper data source which can be used to create the configuration for a bytes processor. The processor converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). See the [bytes processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html) for more details. -Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63. +If the field is an array of strings, all members of the array will be converted. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/bytes-processor.html +Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63. ## Example Usage @@ -55,4 +58,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { - `id` (String) Internal identifier of the resource - `json` (String) JSON representation of this data source. - diff --git a/docs/data-sources/elasticsearch_ingest_processor_circle.md b/docs/data-sources/elasticsearch_ingest_processor_circle.md index a526a56f5..b5784a6d1 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_circle.md +++ b/docs/data-sources/elasticsearch_ingest_processor_circle.md @@ -1,16 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_circle Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_circle Data Source" description: |- - Helper data source to create a processor which converts circle definitions of shapes to regular polygons which approximate them. + Helper data source which can be used to create the configuration for an circle processor. This processor converts circle definitions of shapes to regular polygons which approximate them. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_circle - -Helper data source to which can be used to create a processor to convert circle definitions of shapes to regular polygons which approximate them. +# elasticstack_elasticsearch_ingest_processor_circle (Data Source) -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html +Helper data source which can be used to create the configuration for an circle processor. This processor converts circle definitions of shapes to regular polygons which approximate them. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-circle-processor.html ## Example Usage @@ -57,4 +56,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { - `id` (String) Internal identifier of the resource - `json` (String) JSON representation of this data source. - diff --git a/docs/data-sources/elasticsearch_ingest_processor_community_id.md b/docs/data-sources/elasticsearch_ingest_processor_community_id.md index bb9bda3d1..c7376d59c 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_community_id.md +++ b/docs/data-sources/elasticsearch_ingest_processor_community_id.md @@ -1,20 +1,21 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_community_id Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_community_id Data Source" description: |- - Helper data source to create a processor which computes the Community ID for network flow data as defined in the Community ID Specification. + Helper data source which can be used to create the configuration for a community ID processor. This processor computes the Community ID for network flow data as defined in the Community ID Specification. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html + You can use a community ID to correlate network events related to a single flow. + The community ID processor reads network flow data from related Elastic Common Schema (ECS) https://www.elastic.co/guide/en/ecs/1.12 fields by default. If you use the ECS, no configuration is required. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_community_id +# elasticstack_elasticsearch_ingest_processor_community_id (Data Source) -Helper data source to which can be used to create a processor to compute the Community ID for network flow data as defined in the [Community ID Specification](https://github.com/corelight/community-id-spec). +Helper data source which can be used to create the configuration for a community ID processor. This processor computes the Community ID for network flow data as defined in the Community ID Specification. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html You can use a community ID to correlate network events related to a single flow. The community ID processor reads network flow data from related [Elastic Common Schema (ECS)](https://www.elastic.co/guide/en/ecs/1.12) fields by default. If you use the ECS, no configuration is required. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/community-id-processor.html - ## Example Usage ```terraform @@ -59,4 +60,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { - `id` (String) Internal identifier of the resource - `json` (String) JSON representation of this data source. - diff --git a/docs/data-sources/elasticsearch_ingest_processor_convert.md b/docs/data-sources/elasticsearch_ingest_processor_convert.md index 25f6d94be..8e120aa6f 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_convert.md +++ b/docs/data-sources/elasticsearch_ingest_processor_convert.md @@ -1,25 +1,37 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_convert Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_convert Data Source" description: |- - Helper data source to create a processor which converts a field in the currently ingested document to a different type, such as converting a string to an integer. + Helper data source which can be used to create the configuration for a convert processor. This processor converts a field in the currently ingested document to a different type, such as converting a string to an integer. See the convert processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html for more details. + The supported types include: + integerlongfloatdoublestringbooleanipauto + Specifying boolean will set the field to true if its string value is equal to true (ignoring case), to false if its string value is equal to false (ignoring case), or it will throw an exception otherwise. + Specifying ip will set the target field to the value of field if it contains a valid IPv4 or IPv6 address that can be indexed into an IP field type. + Specifying auto will attempt to convert the string-valued field into the closest non-string, non-IP type. For example, a field whose value is "true" will be converted to its respective boolean type: true. Do note that float takes precedence of double in auto. A value of "242.15" will "automatically" be converted to 242.15 of type float. If a provided field cannot be appropriately converted, the processor will still process successfully and leave the field value as-is. In such a case, target_field will be updated with the unconverted field value. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_convert +# elasticstack_elasticsearch_ingest_processor_convert (Data Source) -Helper data source to which can be used to convert a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted. +Helper data source which can be used to create the configuration for a convert processor. This processor converts a field in the currently ingested document to a different type, such as converting a string to an integer. See the [convert processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html) for more details. -The supported types include: `integer`, `long`, `float`, `double`, `string`, `boolean`, `ip`, and `auto`. +The supported types include: +- `integer` +- `long` +- `float` +- `double` +- `string` +- `boolean` +- `ip` +- `auto` -Specifying `boolean` will set the field to true if its string value is equal to true (ignore case), to false if its string value is equal to false (ignore case), or it will throw an exception otherwise. +Specifying `boolean` will set the field to true if its string value is equal to true (ignoring case), to false if its string value is equal to false (ignoring case), or it will throw an exception otherwise. Specifying `ip` will set the target field to the value of `field` if it contains a valid IPv4 or IPv6 address that can be indexed into an IP field type. Specifying `auto` will attempt to convert the string-valued `field` into the closest non-string, non-IP type. For example, a field whose value is "true" will be converted to its respective boolean type: true. Do note that float takes precedence of double in auto. A value of "242.15" will "automatically" be converted to 242.15 of type `float`. If a provided field cannot be appropriately converted, the processor will still process successfully and leave the field value as-is. In such a case, `target_field` will be updated with the unconverted field value. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/convert-processor.html - ## Example Usage ```terraform @@ -64,4 +76,3 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { - `id` (String) Internal identifier of the resource - `json` (String) JSON representation of this data source. - diff --git a/docs/data-sources/elasticsearch_ingest_processor_csv.md b/docs/data-sources/elasticsearch_ingest_processor_csv.md index b1b0aa307..be515d791 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_csv.md +++ b/docs/data-sources/elasticsearch_ingest_processor_csv.md @@ -1,16 +1,18 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_csv Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_csv Data Source" description: |- - Helper data source to create a processor which extracts fields from CSV line out of a single text field within a document. + Helper data source which can be used to create the configuration for a CSV processor. This processor extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped. See the CSV processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html for more details. + If the trim option is enabled then any whitespace in the beginning and in the end of each unquoted field will be trimmed. For example with configuration above, a value of A, B will result in field field2 having value {nbsp}B (with space at the beginning). If trim is enabled A, B will result in field field2 having value B (no whitespace). Quoted fields will be left untouched. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_csv +# elasticstack_elasticsearch_ingest_processor_csv (Data Source) -Helper data source to which can be used to extract fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped. +Helper data source which can be used to create the configuration for a CSV processor. This processor extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped. See the [CSV processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html) for more details. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/csv-processor.html +If the `trim` option is enabled then any whitespace in the beginning and in the end of each unquoted field will be trimmed. For example with configuration above, a value of A, B will result in field field2 having value {nbsp}B (with space at the beginning). If trim is enabled A, B will result in field field2 having value B (no whitespace). Quoted fields will be left untouched. ## Example Usage @@ -33,8 +35,6 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { } ``` -If the `trim` option is enabled then any whitespace in the beginning and in the end of each unquoted field will be trimmed. For example with configuration above, a value of A, B will result in field field2 having value {nbsp}B (with space at the beginning). If trim is enabled A, B will result in field field2 having value B (no whitespace). Quoted fields will be left untouched. - ## Schema @@ -60,4 +60,3 @@ If the `trim` option is enabled then any whitespace in the beginning and in the - `id` (String) Internal identifier of the resource - `json` (String) JSON representation of this data source. - diff --git a/docs/data-sources/elasticsearch_ingest_processor_date.md b/docs/data-sources/elasticsearch_ingest_processor_date.md index 69d002d8a..14e7a8a31 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_date.md +++ b/docs/data-sources/elasticsearch_ingest_processor_date.md @@ -1,22 +1,21 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_date Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_date Data Source" description: |- - Helper data source to create a processor which parses dates from fields, and then uses the date or timestamp as the timestamp for the document. + Helper data source which can be used to create the configuration for a date processor. This processor parses dates from fields, and then uses the date or timestamp as the timestamp for the document. See the date processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html for more details. + By default, the date processor adds the parsed date as a new field called @timestamp. You can specify a different field by setting the target_field configuration parameter. Multiple date formats are supported as part of the same date processor definition. They will be used sequentially to attempt parsing the date field, in the same order they were defined as part of the processor definition. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_date +# elasticstack_elasticsearch_ingest_processor_date (Data Source) -Helper data source to which can be used to parse dates from fields, and then uses the date or timestamp as the timestamp for the document. -By default, the date processor adds the parsed date as a new field called `@timestamp`. You can specify a different field by setting the `target_field` configuration parameter. Multiple date formats are supported as part of the same date processor definition. They will be used sequentially to attempt parsing the date field, in the same order they were defined as part of the processor definition. +Helper data source which can be used to create the configuration for a date processor. This processor parses dates from fields, and then uses the date or timestamp as the timestamp for the document. See the [date processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html) for more details. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/date-processor.html +By default, the date processor adds the parsed date as a new field called `@timestamp`. You can specify a different field by setting the `target_field` configuration parameter. Multiple date formats are supported as part of the same date processor definition. They will be used sequentially to attempt parsing the date field, in the same order they were defined as part of the processor definition. ## Example Usage -Here is an example that adds the parsed date to the `timestamp` field based on the `initial_date` field: - ```terraform provider "elasticstack" { elasticsearch {} diff --git a/docs/data-sources/elasticsearch_ingest_processor_date_index_name.md b/docs/data-sources/elasticsearch_ingest_processor_date_index_name.md index 64580f566..409c639b8 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_date_index_name.md +++ b/docs/data-sources/elasticsearch_ingest_processor_date_index_name.md @@ -1,21 +1,22 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_date_index_name Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_date_index_name Data Source" description: |- - Helper data source to create a processor which helps to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. + Helper data source which can be used to create the configuration for a date index name processor. The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. See the date index name processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html for more details. + The processor sets the _index metadata field with a date math index name expression based on the provided index name prefix, a date or timestamp field in the documents being processed and the provided date rounding. + First, this processor fetches the date or timestamp from a field in the document being processed. Optionally, date formatting can be configured on how the field’s value should be parsed into a date. Then this date, the provided index name prefix and the provided date rounding get formatted into a date math index name expression. Also here optionally date formatting can be specified on how the date should be formatted into a date math index name expression. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_date_index_name +# elasticstack_elasticsearch_ingest_processor_date_index_name (Data Source) -The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. +Helper data source which can be used to create the configuration for a date index name processor. The purpose of this processor is to point documents to the right time based index based on a date or timestamp field in a document by using the date math index name support. See the [date index name processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html) for more details. The processor sets the _index metadata field with a date math index name expression based on the provided index name prefix, a date or timestamp field in the documents being processed and the provided date rounding. First, this processor fetches the date or timestamp from a field in the document being processed. Optionally, date formatting can be configured on how the field’s value should be parsed into a date. Then this date, the provided index name prefix and the provided date rounding get formatted into a date math index name expression. Also here optionally date formatting can be specified on how the date should be formatted into a date math index name expression. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/date-index-name-processor.html - ## Example Usage ```terraform diff --git a/docs/data-sources/elasticsearch_ingest_processor_dissect.md b/docs/data-sources/elasticsearch_ingest_processor_dissect.md index 4f8bf46eb..5754da6df 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_dissect.md +++ b/docs/data-sources/elasticsearch_ingest_processor_dissect.md @@ -1,20 +1,22 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_dissect Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_dissect Data Source" description: |- - Helper data source to create a processor which extracts structured fields out of a single text field within a document. + Helper data source which can be used to create the configuration for a dissect processor. This processor extracts structured fields out of a single text field within a document. See the dissect processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html#dissect-processor for more details. + Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document. However unlike the Grok Processor, dissect does not use Regular Expressions. This allows dissect’s syntax to be simple and for some cases faster than the Grok Processor. + Dissect matches a single text field against a defined pattern. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_dissect +# elasticstack_elasticsearch_ingest_processor_dissect (Data Source) + +Helper data source which can be used to create the configuration for a dissect processor. This processor extracts structured fields out of a single text field within a document. See the [dissect processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html#dissect-processor) for more details. Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document. However unlike the Grok Processor, dissect does not use Regular Expressions. This allows dissect’s syntax to be simple and for some cases faster than the Grok Processor. Dissect matches a single text field against a defined pattern. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/dissect-processor.html - ## Example Usage ```terraform diff --git a/docs/data-sources/elasticsearch_ingest_processor_dot_expander.md b/docs/data-sources/elasticsearch_ingest_processor_dot_expander.md index 6c0743fae..0f5d11fc0 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_dot_expander.md +++ b/docs/data-sources/elasticsearch_ingest_processor_dot_expander.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_dot_expander Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_dot_expander Data Source" description: |- - Helper data source to create a processor which expands a field with dots into an object field. + Helper data source which can be used to create the configuration for a dot expander processor. This processor expands a field with dots into an object field. See the dot expand processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_dot_expander - -Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor. - -See: elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html +# elasticstack_elasticsearch_ingest_processor_dot_expander (Data Source) +Helper data source which can be used to create the configuration for a dot expander processor. This processor expands a field with dots into an object field. See the [dot expand processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/dot-expand-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_drop.md b/docs/data-sources/elasticsearch_ingest_processor_drop.md index cb7ebd9f8..c677749b7 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_drop.md +++ b/docs/data-sources/elasticsearch_ingest_processor_drop.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_drop Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_drop Data Source" description: |- - Helper data source to create a processor which drops the document without raising any errors. + Helper data source which can be used to create the configuration for a drop processor. This processor drops the document without raising any errors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_drop - -Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html +# elasticstack_elasticsearch_ingest_processor_drop (Data Source) +Helper data source which can be used to create the configuration for a drop processor. This processor drops the document without raising any errors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/drop-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_enrich.md b/docs/data-sources/elasticsearch_ingest_processor_enrich.md index b1f66e565..4e4c61d14 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_enrich.md +++ b/docs/data-sources/elasticsearch_ingest_processor_enrich.md @@ -1,16 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_enrich Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_enrich Data Source" description: |- - Helper data source to create a processor which enriches documents with data from another index. + Helper data source which can be used to create the configuration for an enrich processor. The enrich processor can enrich documents with data from another index. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_enrich - -The enrich processor can enrich documents with data from another index. See enrich data section for more information about how to set this up. +# elasticstack_elasticsearch_ingest_processor_enrich (Data Source) -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-enriching-data.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html +Helper data source which can be used to create the configuration for an enrich processor. The enrich processor can enrich documents with data from another index. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_fail.md b/docs/data-sources/elasticsearch_ingest_processor_fail.md index 3ae3b778b..3ebc14892 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_fail.md +++ b/docs/data-sources/elasticsearch_ingest_processor_fail.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_fail Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_fail Data Source" description: |- - Helper data source to create a processor which raises an exception. + Helper data source which can be used to create the configuration for a fail processor. This processor raises an exception. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_fail - -Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html +# elasticstack_elasticsearch_ingest_processor_fail (Data Source) +Helper data source which can be used to create the configuration for a fail processor. This processor raises an exception. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/fail-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_fingerprint.md b/docs/data-sources/elasticsearch_ingest_processor_fingerprint.md index f852e051f..264b60787 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_fingerprint.md +++ b/docs/data-sources/elasticsearch_ingest_processor_fingerprint.md @@ -1,16 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_fingerprint Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_fingerprint Data Source" description: |- - Helper data source to create a processor which computes a hash of the document’s content. + Helper data source which can be used to create the configuration for a fingerprint processor. This processor computes a hash of the document’s content. See the fingerprint processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_fingerprint - -Computes a hash of the document’s content. You can use this hash for content fingerprinting. +# elasticstack_elasticsearch_ingest_processor_fingerprint (Data Source) -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html +Helper data source which can be used to create the configuration for a fingerprint processor. This processor computes a hash of the document’s content. See the [fingerprint processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/fingerprint-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_foreach.md b/docs/data-sources/elasticsearch_ingest_processor_foreach.md index a448a7234..32aea4bdd 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_foreach.md +++ b/docs/data-sources/elasticsearch_ingest_processor_foreach.md @@ -1,22 +1,26 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_foreach Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_foreach Data Source" description: |- - Helper data source to create a processor which runs an ingest processor on each element of an array or object. + Helper data source which can be used to create the configuration for a foreach processor. This processor runs an ingest processor on each element of an array or object. See the foreach processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html for more details. + All ingest processors can run on array or object elements. However, if the number of elements is unknown, it can be cumbersome to process each one in the same way. + The foreach processor lets you specify a field containing array or object values and a processor to run on each element in the field. + Access keys and values + When iterating through an array or object, the foreach processor stores the current element’s value in the _ingest._value ingest metadata field. _ingest._value contains the entire element value, including any child fields. You can access child field values using dot notation on the _ingest._value field. + When iterating through an object, the foreach processor also stores the current element’s key as a string in _ingest._key. + You can access and change _ingest._key and _ingest._value in the processor. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_foreach +# elasticstack_elasticsearch_ingest_processor_foreach (Data Source) -Runs an ingest processor on each element of an array or object. +Helper data source which can be used to create the configuration for a foreach processor. This processor runs an ingest processor on each element of an array or object. See the [foreach processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html) for more details. All ingest processors can run on array or object elements. However, if the number of elements is unknown, it can be cumbersome to process each one in the same way. The `foreach` processor lets you specify a `field` containing array or object values and a `processor` to run on each element in the field. -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/foreach-processor.html - - ### Access keys and values When iterating through an array or object, the foreach processor stores the current element’s value in the `_ingest._value` ingest metadata field. `_ingest._value` contains the entire element value, including any child fields. You can access child field values using dot notation on the `_ingest._value` field. @@ -25,8 +29,6 @@ When iterating through an object, the foreach processor also stores the current You can access and change `_ingest._key` and `_ingest._value` in the processor. - - ## Example Usage ```terraform diff --git a/docs/data-sources/elasticsearch_ingest_processor_geoip.md b/docs/data-sources/elasticsearch_ingest_processor_geoip.md index efec6890d..56cbd111c 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_geoip.md +++ b/docs/data-sources/elasticsearch_ingest_processor_geoip.md @@ -1,24 +1,24 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_geoip Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_geoip Data Source" description: |- - Helper data source to create a processor which adds information about the geographical location of an IPv4 or IPv6 address. + Helper data source which can be used to create the configuration for a geoip processor. The geoip processor adds information about the geographical location of an IPv4 or IPv6 address. See the geoip processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html for more details. + By default, the processor uses the GeoLite2 City, GeoLite2 Country, and GeoLite2 ASN GeoIP2 databases from MaxMind, shared under the CC BY-SA 4.0 license. Elasticsearch automatically downloads updates for these databases from the Elastic GeoIP endpoint: https://geoip.elastic.co/v1/database. To get download statistics for these updates, use the GeoIP stats API. + If your cluster can’t connect to the Elastic GeoIP endpoint or you want to manage your own updates, see Manage your own GeoIP2 database updates https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html#manage-geoip-database-updates. + If Elasticsearch can’t connect to the endpoint for 30 days all updated databases will become invalid. Elasticsearch will stop enriching documents with geoip data and will add tags: ["_geoip_expired_database"] field instead. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_geoip +# elasticstack_elasticsearch_ingest_processor_geoip (Data Source) -The geoip processor adds information about the geographical location of an IPv4 or IPv6 address. +Helper data source which can be used to create the configuration for a geoip processor. The geoip processor adds information about the geographical location of an IPv4 or IPv6 address. See the [geoip processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html) for more details. By default, the processor uses the GeoLite2 City, GeoLite2 Country, and GeoLite2 ASN GeoIP2 databases from MaxMind, shared under the CC BY-SA 4.0 license. Elasticsearch automatically downloads updates for these databases from the Elastic GeoIP endpoint: https://geoip.elastic.co/v1/database. To get download statistics for these updates, use the GeoIP stats API. If your cluster can’t connect to the Elastic GeoIP endpoint or you want to manage your own updates, [see Manage your own GeoIP2 database updates](https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html#manage-geoip-database-updates). -If Elasticsearch can’t connect to the endpoint for 30 days all updated databases will become invalid. Elasticsearch will stop enriching documents with geoip data and will add tags: ["_geoip_expired_database"] field instead. - - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-processor.html - +If Elasticsearch can’t connect to the endpoint for 30 days all updated databases will become invalid. Elasticsearch will stop enriching documents with geoip data and will add `tags: ["_geoip_expired_database"]` field instead. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_grok.md b/docs/data-sources/elasticsearch_ingest_processor_grok.md index 9a078fc26..4a002a33c 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_grok.md +++ b/docs/data-sources/elasticsearch_ingest_processor_grok.md @@ -1,23 +1,22 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_grok Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_grok Data Source" description: |- - Helper data source to create a processor which extracts structured fields out of a single text field within a document. + Helper data source which can be used to create the configuration for a grok processor. This processor extracts structured fields out of a single text field within a document. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html + This processor comes packaged with many reusable patterns https://github.com/elastic/elasticsearch/blob/master/libs/grok/src/main/resources/patterns. + If you need help building patterns to match your logs, you will find the Grok Debugger https://www.elastic.co/guide/en/kibana/master/xpack-grokdebugger.html tool quite useful! The Grok Constructor https://grokconstructor.appspot.com/ is also a useful tool. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_grok +# elasticstack_elasticsearch_ingest_processor_grok (Data Source) -Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused. +Helper data source which can be used to create the configuration for a grok processor. This processor extracts structured fields out of a single text field within a document. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html This processor comes packaged with many [reusable patterns](https://github.com/elastic/elasticsearch/blob/master/libs/grok/src/main/resources/patterns). If you need help building patterns to match your logs, you will find the [Grok Debugger](https://www.elastic.co/guide/en/kibana/master/xpack-grokdebugger.html) tool quite useful! [The Grok Constructor](https://grokconstructor.appspot.com/) is also a useful tool. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html - - ## Example Usage ```terraform diff --git a/docs/data-sources/elasticsearch_ingest_processor_gsub.md b/docs/data-sources/elasticsearch_ingest_processor_gsub.md index 3798599c7..e75bb2f4a 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_gsub.md +++ b/docs/data-sources/elasticsearch_ingest_processor_gsub.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_gsub Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_gsub Data Source" description: |- - Helper data source to create a processor which converts a string field by applying a regular expression and a replacement. + Helper data source which can be used to create the configuration for a gsub processor. This processor converts a string field by applying a regular expression and a replacement. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_gsub - -Converts a string field by applying a regular expression and a replacement. If the field is an array of string, all members of the array will be converted. If any non-string values are encountered, the processor will throw an exception. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html +# elasticstack_elasticsearch_ingest_processor_gsub (Data Source) +Helper data source which can be used to create the configuration for a gsub processor. This processor converts a string field by applying a regular expression and a replacement. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/gsub-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_html_strip.md b/docs/data-sources/elasticsearch_ingest_processor_html_strip.md index ba34acda0..171b76ed8 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_html_strip.md +++ b/docs/data-sources/elasticsearch_ingest_processor_html_strip.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_html_strip Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_html_strip Data Source" description: |- - Helper data source to create a processor which removes HTML tags from the field. + Helper data source which can be used to create the configuration for an HTML strip processor. This processor removes HTML tags from the field. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/htmlstrip-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_html_strip - -Removes HTML tags from the field. If the field is an array of strings, HTML tags will be removed from all members of the array. - -See: templates/data-sources/elasticsearch_ingest_processor_html_strip.md.tmpl +# elasticstack_elasticsearch_ingest_processor_html_strip (Data Source) +Helper data source which can be used to create the configuration for an HTML strip processor. This processor removes HTML tags from the field. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/htmlstrip-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_join.md b/docs/data-sources/elasticsearch_ingest_processor_join.md index 866178a67..a46139936 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_join.md +++ b/docs/data-sources/elasticsearch_ingest_processor_join.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_join Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_join Data Source" description: |- - Helper data source to create a processor which joins each element of an array into a single string using a separator character between each element. + Helper data source which can be used to create the configuration for a join processor. This processor joins each element of an array into a single string using a separator character between each element. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_join - -Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html +# elasticstack_elasticsearch_ingest_processor_join (Data Source) +Helper data source which can be used to create the configuration for a join processor. This processor joins each element of an array into a single string using a separator character between each element. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/join-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_json.md b/docs/data-sources/elasticsearch_ingest_processor_json.md index f7b3d3c5a..e2a1e8989 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_json.md +++ b/docs/data-sources/elasticsearch_ingest_processor_json.md @@ -1,16 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_json Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_json Data Source" description: |- - Helper data source to create a processor which converts a JSON string into a structured JSON object. + Helper data source which can be used to create the configuration for a JSON processor. This processor converts a JSON string into a structured JSON object. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_json - -Converts a JSON string into a structured JSON object. +# elasticstack_elasticsearch_ingest_processor_json (Data Source) -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html +Helper data source which can be used to create the configuration for a JSON processor. This processor converts a JSON string into a structured JSON object. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/json-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_kv.md b/docs/data-sources/elasticsearch_ingest_processor_kv.md index 7dc000a0a..c3c901e98 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_kv.md +++ b/docs/data-sources/elasticsearch_ingest_processor_kv.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_kv Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_kv Data Source" description: |- - Helper data source to create a processor which helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. + Helper data source which can be used to create the configuration for a KV processor. This processor helps automatically parse messages (or specific event fields) which are of the foo=bar variety. See the KV processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_kv - -This processor helps automatically parse messages (or specific event fields) which are of the `foo=bar` variety. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html +# elasticstack_elasticsearch_ingest_processor_kv (Data Source) +Helper data source which can be used to create the configuration for a KV processor. This processor helps automatically parse messages (or specific event fields) which are of the foo=bar variety. See the [KV processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/kv-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_lowercase.md b/docs/data-sources/elasticsearch_ingest_processor_lowercase.md index b8f6c903b..0e030f1cd 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_lowercase.md +++ b/docs/data-sources/elasticsearch_ingest_processor_lowercase.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_lowercase Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_lowercase Data Source" description: |- - Helper data source to create a processor which converts a string to its lowercase equivalent. + Helper data source which can be used to create the configuration for a lowercase processor. This processor converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted. See the lowercase processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_lowercase - -Converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html +# elasticstack_elasticsearch_ingest_processor_lowercase (Data Source) +Helper data source which can be used to create the configuration for a lowercase processor. This processor converts a string to its lowercase equivalent. If the field is an array of strings, all members of the array will be converted. See the [lowercase processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/lowercase-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_network_direction.md b/docs/data-sources/elasticsearch_ingest_processor_network_direction.md index 7ab772a41..956158833 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_network_direction.md +++ b/docs/data-sources/elasticsearch_ingest_processor_network_direction.md @@ -1,21 +1,26 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_network_direction Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_network_direction Data Source" description: |- - Helper data source to create a processor which calculates the network direction given a source IP address, destination IP address, and a list of internal networks. + Helper data source which can be used to create the configuration for a network direction processor. This processor calculates the network direction given a source IP address, destination IP address, and a list of internal networks. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html + The network direction processor reads IP addresses from Elastic Common Schema (ECS) fields by default. If you use the ECS, only the internal_networks option must be specified. + One of either internal_networks or internal_networks_field must be specified. If internal_networks_field is specified, it follows the behavior specified by ignore_missing. + Supported named network ranges + The named ranges supported for the internal_networks option are: + loopback - Matches loopback addresses in the range of 127.0.0.0/8 or ::1/128.unicast or global_unicast - Matches global unicast addresses defined in RFC 1122, RFC 4632, and RFC 4291 with the exception of the IPv4 broadcast address (255.255.255.255). This includes private address ranges.multicast - Matches multicast addresses.interface_local_multicast - Matches IPv6 interface-local multicast addresses.link_local_unicast - Matches link-local unicast addresses.link_local_multicast - Matches link-local multicast addresses.private - Matches private address ranges defined in RFC 1918 (IPv4) and RFC 4193 (IPv6).public - Matches addresses that are not loopback, unspecified, IPv4 broadcast, link local unicast, link local multicast, interface local multicast, or private.unspecified - Matches unspecified addresses (either the IPv4 address "0.0.0.0" or the IPv6 address "::"). --- -# Data Source: elasticstack_elasticsearch_ingest_processor_network_direction +# elasticstack_elasticsearch_ingest_processor_network_direction (Data Source) -Calculates the network direction given a source IP address, destination IP address, and a list of internal networks. +Helper data source which can be used to create the configuration for a network direction processor. This processor calculates the network direction given a source IP address, destination IP address, and a list of internal networks. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html The network direction processor reads IP addresses from Elastic Common Schema (ECS) fields by default. If you use the ECS, only the `internal_networks` option must be specified. - One of either `internal_networks` or `internal_networks_field` must be specified. If `internal_networks_field` is specified, it follows the behavior specified by `ignore_missing`. -### Supported named network rangese +### Supported named network ranges The named ranges supported for the internal_networks option are: @@ -29,10 +34,6 @@ The named ranges supported for the internal_networks option are: * `public` - Matches addresses that are not loopback, unspecified, IPv4 broadcast, link local unicast, link local multicast, interface local multicast, or private. * `unspecified` - Matches unspecified addresses (either the IPv4 address "0.0.0.0" or the IPv6 address "::"). - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/network-direction-processor.html - - ## Example Usage ```terraform diff --git a/docs/data-sources/elasticsearch_ingest_processor_pipeline.md b/docs/data-sources/elasticsearch_ingest_processor_pipeline.md index 4374db6ce..8cf90edd5 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_pipeline.md +++ b/docs/data-sources/elasticsearch_ingest_processor_pipeline.md @@ -1,19 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_pipeline Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_pipeline Data Source" description: |- - Helper data source to create a processor which executes another pipeline. + Helper data source which can be used to create the configuration for a pipeline processor. This processor executes another pipeline. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_pipeline - -Executes another pipeline. - -The name of the current pipeline can be accessed from the `_ingest.pipeline` ingest metadata key. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html +# elasticstack_elasticsearch_ingest_processor_pipeline (Data Source) +Helper data source which can be used to create the configuration for a pipeline processor. This processor executes another pipeline. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/pipeline-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_registered_domain.md b/docs/data-sources/elasticsearch_ingest_processor_registered_domain.md index 215a0be3a..0641c9983 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_registered_domain.md +++ b/docs/data-sources/elasticsearch_ingest_processor_registered_domain.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_registered_domain Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_registered_domain Data Source" description: |- - Helper data source to create a processor which Extracts the registered domain, sub-domain, and top-level domain from a fully qualified domain name. + Helper data source which can be used to create the configuration for a registered domain processor. This processor extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). See: https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_registered_domain - -Extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). Uses the registered domains defined in the Mozilla Public Suffix List. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html +# elasticstack_elasticsearch_ingest_processor_registered_domain (Data Source) +Helper data source which can be used to create the configuration for a registered domain processor. This processor extracts the registered domain (also known as the effective top-level domain or eTLD), sub-domain, and top-level domain from a fully qualified domain name (FQDN). See: https://www.elastic.co/guide/en/elasticsearch/reference/current/registered-domain-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_remove.md b/docs/data-sources/elasticsearch_ingest_processor_remove.md index 5a5a1984c..d1db4f7e3 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_remove.md +++ b/docs/data-sources/elasticsearch_ingest_processor_remove.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_remove Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_remove Data Source" description: |- - Helper data source to create a processor which removes existing fields. + Helper data source which can be used to create the configuration for a remove processor. This processor removes existing fields. See the remove processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_remove - -Removes existing fields. If one field doesn’t exist, an exception will be thrown. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html +# elasticstack_elasticsearch_ingest_processor_remove (Data Source) +Helper data source which can be used to create the configuration for a remove processor. This processor removes existing fields. See the [remove processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/remove-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_rename.md b/docs/data-sources/elasticsearch_ingest_processor_rename.md index f1268b4f5..57effd437 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_rename.md +++ b/docs/data-sources/elasticsearch_ingest_processor_rename.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_rename Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_rename Data Source" description: |- - Helper data source to create a processor which renames an existing field. + Helper data source which can be used to create the configuration for a rename processor. This processor renames an existing field. See the rename processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_rename - -Renames an existing field. If the field doesn’t exist or the new name is already used, an exception will be thrown. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html +# elasticstack_elasticsearch_ingest_processor_rename (Data Source) +Helper data source which can be used to create the configuration for a rename processor. This processor renames an existing field. See the [rename processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/rename-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_reroute.md b/docs/data-sources/elasticsearch_ingest_processor_reroute.md index bcb5a9bb0..32b763744 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_reroute.md +++ b/docs/data-sources/elasticsearch_ingest_processor_reroute.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_reroute Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_reroute Data Source" description: |- - Helper data source to create a processor which reroutes a document to a different data stream, index, or index alias. + Helper data source which can be used to create the configuration for a reroute processor. This processor reroutes a document to a different data stream, index, or index alias. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_reroute - -Reroutes a document to a different data stream, index, or index alias. This processor is useful for routing documents based on data stream routing rules. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html +# elasticstack_elasticsearch_ingest_processor_reroute (Data Source) +Helper data source which can be used to create the configuration for a reroute processor. This processor reroutes a document to a different data stream, index, or index alias. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/reroute-processor.html ## Example Usage @@ -52,4 +50,4 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { ### Read-Only - `id` (String) Internal identifier of the resource. -- `json` (String) JSON representation of this data source. \ No newline at end of file +- `json` (String) JSON representation of this data source. diff --git a/docs/data-sources/elasticsearch_ingest_processor_script.md b/docs/data-sources/elasticsearch_ingest_processor_script.md index b52d3cb41..fda8e951d 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_script.md +++ b/docs/data-sources/elasticsearch_ingest_processor_script.md @@ -1,27 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_script Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_script Data Source" description: |- - Helper data source to create a processor which runs an inline or stored script on incoming documents. + Helper data source which can be used to create the configuration for a script processor. This processor runs an inline or stored script on incoming documents. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_script - -Runs an inline or stored script on incoming documents. The script runs in the ingest context. - -The script processor uses the script cache to avoid recompiling the script for each incoming document. To improve performance, ensure the script cache is properly sized before using a script processor in production. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html - -### Access source fields - -The script processor parses each incoming document’s JSON source fields into a set of maps, lists, and primitives. To access these fields with a Painless script, use the map access operator: `ctx['my-field']`. You can also use the shorthand `ctx.` syntax. - -### Access metadata fields - -You can also use a script processor to access metadata fields. +# elasticstack_elasticsearch_ingest_processor_script (Data Source) +Helper data source which can be used to create the configuration for a script processor. This processor runs an inline or stored script on incoming documents. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/script-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_set.md b/docs/data-sources/elasticsearch_ingest_processor_set.md index 6eeab00e1..bf6b65838 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_set.md +++ b/docs/data-sources/elasticsearch_ingest_processor_set.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_set Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_set Data Source" description: |- - Helper data source to create a processor which sets one field and associates it with the specified value. + Helper data source which can be used to create the configuration for a set processor. This processor sets one field and associates it with the specified value. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_set - -Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html +# elasticstack_elasticsearch_ingest_processor_set (Data Source) +Helper data source which can be used to create the configuration for a set processor. This processor sets one field and associates it with the specified value. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/set-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_set_security_user.md b/docs/data-sources/elasticsearch_ingest_processor_set_security_user.md index 62249a9f0..2586e6470 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_set_security_user.md +++ b/docs/data-sources/elasticsearch_ingest_processor_set_security_user.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_set_security_user Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_set_security_user Data Source" description: |- - Helper data source to create a processor which sets user-related details from the current authenticated user to the current document by pre-processing the ingest. + Helper data source which can be used to create the configuration for a set security user processor. This processor sets user-related details (such as username, roles, email, full_name, metadata, api_key, realm and authentication_type) from the current authenticated user to the current document by pre-processing the ingest. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-node-set-security-user-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_set_security_user - -Sets user-related details (such as `username`, `roles`, `email`, `full_name`, `metadata`, `api_key`, `realm` and `authentication_typ`e) from the current authenticated user to the current document by pre-processing the ingest. The `api_key` property exists only if the user authenticates with an API key. It is an object containing the id, name and metadata (if it exists and is non-empty) fields of the API key. The realm property is also an object with two fields, name and type. When using API key authentication, the realm property refers to the realm from which the API key is created. The `authentication_type property` is a string that can take value from `REALM`, `API_KEY`, `TOKEN` and `ANONYMOUS`. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-node-set-security-user-processor.html +# elasticstack_elasticsearch_ingest_processor_set_security_user (Data Source) +Helper data source which can be used to create the configuration for a set security user processor. This processor sets user-related details (such as username, roles, email, full_name, metadata, api_key, realm and authentication_type) from the current authenticated user to the current document by pre-processing the ingest. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-node-set-security-user-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_sort.md b/docs/data-sources/elasticsearch_ingest_processor_sort.md index c4c240503..a565104b4 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_sort.md +++ b/docs/data-sources/elasticsearch_ingest_processor_sort.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_sort Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_sort Data Source" description: |- - Helper data source to create a processor which sorts the elements of an array ascending or descending. + Helper data source which can be used to create the configuration for a sort processor. This processor sorts the elements of an array ascending or descending. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_sort - -Sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings + numbers will be sorted lexicographically. Throws an error when the field is not an array. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html +# elasticstack_elasticsearch_ingest_processor_sort (Data Source) +Helper data source which can be used to create the configuration for a sort processor. This processor sorts the elements of an array ascending or descending. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_split.md b/docs/data-sources/elasticsearch_ingest_processor_split.md index d8f318509..c95f3b878 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_split.md +++ b/docs/data-sources/elasticsearch_ingest_processor_split.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_split Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_split Data Source" description: |- - Helper data source to create a processor which splits a field into an array using a separator character. + Helper data source which can be used to create the configuration for a split processor. This processor splits a field into an array using a separator character. See the split processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_split - -Splits a field into an array using a separator character. Only works on string fields. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html +# elasticstack_elasticsearch_ingest_processor_split (Data Source) +Helper data source which can be used to create the configuration for a split processor. This processor splits a field into an array using a separator character. See the [split processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/split-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_trim.md b/docs/data-sources/elasticsearch_ingest_processor_trim.md index 4f230cff9..224fe5b99 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_trim.md +++ b/docs/data-sources/elasticsearch_ingest_processor_trim.md @@ -1,19 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_trim Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_trim Data Source" description: |- - Helper data source to create a processor which trims whitespace from field. + Helper data source which can be used to create the configuration for a trim processor. This processor trims whitespace from field. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_trim - -Trims whitespace from field. If the field is an array of strings, all members of the array will be trimmed. - -**NOTE:** This only works on leading and trailing whitespace. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html +# elasticstack_elasticsearch_ingest_processor_trim (Data Source) +Helper data source which can be used to create the configuration for a trim processor. This processor trims whitespace from field. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/trim-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_uppercase.md b/docs/data-sources/elasticsearch_ingest_processor_uppercase.md index 6954ed14c..21b3c7fb9 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_uppercase.md +++ b/docs/data-sources/elasticsearch_ingest_processor_uppercase.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_uppercase Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_uppercase Data Source" description: |- - Helper data source to create a processor which converts a string to its uppercase equivalent. + Helper data source which can be used to create the configuration for an uppercase processor. This processor converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted. See the uppercase processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_uppercase - -Converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html +# elasticstack_elasticsearch_ingest_processor_uppercase (Data Source) +Helper data source which can be used to create the configuration for an uppercase processor. This processor converts a string to its uppercase equivalent. If the field is an array of strings, all members of the array will be converted. See the [uppercase processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/uppercase-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_uri_parts.md b/docs/data-sources/elasticsearch_ingest_processor_uri_parts.md index 5867f8baf..2e6db8a25 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_uri_parts.md +++ b/docs/data-sources/elasticsearch_ingest_processor_uri_parts.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_uri_parts Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_uri_parts Data Source" description: |- - Helper data source to create a processor which parses a Uniform Resource Identifier (URI) string and extracts its components as an object. + Helper data source which can be used to create the configuration for a URI parts processor. This processor parses a Uniform Resource Identifier (URI) string and extracts its components as an object. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/uri-parts-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_uri_parts - -Parses a Uniform Resource Identifier (URI) string and extracts its components as an object. This URI object includes properties for the URI’s domain, path, fragment, port, query, scheme, user info, username, and password. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/uri-parts-processor.html +# elasticstack_elasticsearch_ingest_processor_uri_parts (Data Source) +Helper data source which can be used to create the configuration for a URI parts processor. This processor parses a Uniform Resource Identifier (URI) string and extracts its components as an object. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/uri-parts-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_urldecode.md b/docs/data-sources/elasticsearch_ingest_processor_urldecode.md index e8dae0d43..1e32ea90f 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_urldecode.md +++ b/docs/data-sources/elasticsearch_ingest_processor_urldecode.md @@ -1,17 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_urldecode Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_urldecode Data Source" description: |- - Helper data source to create a processor which URL-decodes a string. + Helper data source which can be used to create the configuration for a URL-decode processor. This processor URL-decodes a string. See the URL decode processor documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html for more details. --- -# Data Source: elasticstack_elasticsearch_ingest_processor_urldecode - -URL-decodes a string. If the field is an array of strings, all members of the array will be decoded. - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html +# elasticstack_elasticsearch_ingest_processor_urldecode (Data Source) +Helper data source which can be used to create the configuration for a URL-decode processor. This processor URL-decodes a string. See the [URL decode processor documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/urldecode-processor.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_ingest_processor_user_agent.md b/docs/data-sources/elasticsearch_ingest_processor_user_agent.md index 1c728515b..3d07503f0 100644 --- a/docs/data-sources/elasticsearch_ingest_processor_user_agent.md +++ b/docs/data-sources/elasticsearch_ingest_processor_user_agent.md @@ -1,20 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_processor_user_agent Data Source - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_processor_user_agent Data Source" description: |- - Helper data source to create a processor which extracts details from the user agent string a browser sends with its web requests. + Helper data source which can be used to create the configuration for a user agent processor. This processor extracts details from the user agent string a browser sends with its web requests. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html --- -# Data Source: elasticstack_elasticsearch_ingest_processor_user_agent - -The `user_agent` processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the `user_agent` field. - -The ingest-user-agent module ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license. For more details see https://github.com/ua-parser/uap-core. - - -See: https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html +# elasticstack_elasticsearch_ingest_processor_user_agent (Data Source) +Helper data source which can be used to create the configuration for a user agent processor. This processor extracts details from the user agent string a browser sends with its web requests. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/user-agent-processor.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_security_role.md b/docs/data-sources/elasticsearch_security_role.md index f41c364c0..4f50c343b 100644 --- a/docs/data-sources/elasticsearch_security_role.md +++ b/docs/data-sources/elasticsearch_security_role.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_security_role Data Source - terraform-provider-elasticstack" subcategory: "Security" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_security_role Data Source" description: |- - Retrieves roles in the native realm. + Retrieves roles in the native realm. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html --- -# Data Source: elasticstack_elasticsearch_security_role +# elasticstack_elasticsearch_security_role (Data Source) -Use this data source to get information about an existing Elasticsearch role. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html +Retrieves roles in the native realm. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html ## Example Usage diff --git a/docs/data-sources/elasticsearch_security_role_mapping.md b/docs/data-sources/elasticsearch_security_role_mapping.md index 01c6ca5ab..83eef6d35 100644 --- a/docs/data-sources/elasticsearch_security_role_mapping.md +++ b/docs/data-sources/elasticsearch_security_role_mapping.md @@ -1,12 +1,13 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_security_role_mapping Data Source - terraform-provider-elasticstack" subcategory: "Security" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_security_role_mapping Data Source" description: |- - Retrieves role mappings. + Retrieves role mappings. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html --- -# Data Source: elasticstack_elasticsearch_security_role_mapping +# elasticstack_elasticsearch_security_role_mapping (Data Source) Retrieves role mappings. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html diff --git a/docs/data-sources/elasticsearch_security_user.md b/docs/data-sources/elasticsearch_security_user.md index 6fc2c049c..5d180e67a 100644 --- a/docs/data-sources/elasticsearch_security_user.md +++ b/docs/data-sources/elasticsearch_security_user.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_security_user Data Source - terraform-provider-elasticstack" subcategory: "Security" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_security_user Data Source" description: |- - Gets information about Elasticsearch user. + Get the information about the user in the ES cluster. See the security API get user documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html for more details. --- -# Data Source: elasticstack_elasticsearch_security_user +# elasticstack_elasticsearch_security_user (Data Source) -Use this data source to get information about existing Elasticsearch user. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html". +Get the information about the user in the ES cluster. See the [security API get user documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html) for more details. ## Example Usage diff --git a/docs/data-sources/elasticsearch_snapshot_repository.md b/docs/data-sources/elasticsearch_snapshot_repository.md index 7004d0ef4..9987b6e1e 100644 --- a/docs/data-sources/elasticsearch_snapshot_repository.md +++ b/docs/data-sources/elasticsearch_snapshot_repository.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_snapshot_repository Data Source - terraform-provider-elasticstack" subcategory: "Snapshot" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_snapshot_repository Data Source" description: |- Gets information about the registered snapshot repositories. --- -# Data Source: elasticstack_elasticsearch_snapshot_repository +# elasticstack_elasticsearch_snapshot_repository (Data Source) -This data source provides the information about the registered snaphosts repositories +Gets information about the registered snapshot repositories. ## Example Usage diff --git a/docs/data-sources/fleet_enrollment_tokens.md b/docs/data-sources/fleet_enrollment_tokens.md index 215ba3621..bfe6753e9 100644 --- a/docs/data-sources/fleet_enrollment_tokens.md +++ b/docs/data-sources/fleet_enrollment_tokens.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_fleet_enrollment_tokens Data Source - terraform-provider-elasticstack" subcategory: "Fleet" -layout: "" -page_title: "Elasticstack: elasticstack_fleet_enrollment_tokens Data Source" description: |- - Gets information about Fleet Enrollment Tokens. See https://www.elastic.co/guide/en/fleet/current/fleet-enrollment-tokens.html + Retrieves Elasticsearch API keys used to enroll Elastic Agents in Fleet. See the Fleet enrollment tokens documentation https://www.elastic.co/guide/en/fleet/current/fleet-enrollment-tokens.html for more details. --- -# Data Source: elasticstack_fleet_enrollment_tokens +# elasticstack_fleet_enrollment_tokens (Data Source) -This data source provides information about Fleet Enrollment Tokens. +Retrieves Elasticsearch API keys used to enroll Elastic Agents in Fleet. See the [Fleet enrollment tokens documentation](https://www.elastic.co/guide/en/fleet/current/fleet-enrollment-tokens.html) for more details. ## Example Usage diff --git a/docs/data-sources/fleet_integration.md b/docs/data-sources/fleet_integration.md index 4b329781c..9a9493cf1 100644 --- a/docs/data-sources/fleet_integration.md +++ b/docs/data-sources/fleet_integration.md @@ -1,12 +1,21 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_fleet_integration Data Source - terraform-provider-elasticstack" subcategory: "Fleet" -layout: "" -page_title: "Elasticstack: elasticstack_fleet_integration Data Source" description: |- - Gets information about a Fleet integration package. + This data source provides information about a Fleet integration package. Currently, + the data source will retrieve the latest available version of the package. Version + selection is determined by the Fleet API, which is currently based on semantic + versioning. + By default, the highest GA release version will be selected. If a + package is not GA (the version is below 1.0.0) or if a new non-GA version of the + package is to be selected (i.e., the GA version of the package is 1.5.0, but there's + a new 1.5.1-beta version available), then the prerelease parameter in the plan + should be set to true. --- -# Data Source: elasticstack_fleet_integration +# elasticstack_fleet_integration (Data Source) This data source provides information about a Fleet integration package. Currently, the data source will retrieve the latest available version of the package. Version diff --git a/docs/data-sources/kibana_action_connector.md b/docs/data-sources/kibana_action_connector.md index 5513b5d70..ed5b3b505 100644 --- a/docs/data-sources/kibana_action_connector.md +++ b/docs/data-sources/kibana_action_connector.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_kibana_action_connector Data Source - terraform-provider-elasticstack" subcategory: "Kibana" -layout: "" -page_title: "Elasticstack: elasticstack_kibana_action_connector Data Source" description: |- - Retrieve a specific action connector role. See https://www.elastic.co/guide/en/kibana/current/get-all-connectors-api.html. + Search for a connector by name, space id, and type. Note, that this data source will fail if more than one connector shares the same name. --- -# Data Source: elasticstack_kibana_action_connector +# elasticstack_kibana_action_connector (Data Source) -Use this data source to get information about an existing action connector. +Search for a connector by name, space id, and type. Note, that this data source will fail if more than one connector shares the same name. ## Example Usage diff --git a/docs/data-sources/kibana_security_role.md b/docs/data-sources/kibana_security_role.md index f2db9f711..8f145f918 100644 --- a/docs/data-sources/kibana_security_role.md +++ b/docs/data-sources/kibana_security_role.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_kibana_security_role Data Source - terraform-provider-elasticstack" subcategory: "Kibana" -layout: "" -page_title: "Elasticstack: elasticstack_kibana_security_role Data Source" description: |- - Retrieve a specific Kibana role. See https://www.elastic.co/guide/en/kibana/master/role-management-specific-api-get.html + Retrieve a specific role. See the role management API documentation https://www.elastic.co/guide/en/kibana/current/role-management-specific-api-get.html for more details. --- -# Data Source: elasticstack_kibana_security_role +# elasticstack_kibana_security_role (Data Source) -Use this data source to get information about an existing Kibana role. +Retrieve a specific role. See the [role management API documentation](https://www.elastic.co/guide/en/kibana/current/role-management-specific-api-get.html) for more details. ## Example Usage diff --git a/docs/data-sources/kibana_spaces.md b/docs/data-sources/kibana_spaces.md index efcfdc282..df1d7fb28 100644 --- a/docs/data-sources/kibana_spaces.md +++ b/docs/data-sources/kibana_spaces.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_kibana_spaces Data Source - terraform-provider-elasticstack" subcategory: "Kibana" -layout: "" -page_title: "Elasticstack: elasticstack_kibana_spaces Data Source" description: |- - Retrieve all Kibana spaces. See https://www.elastic.co/guide/en/kibana/master/spaces-api-get-all.html + Use this data source to retrieve and get information about all existing Kibana spaces. See https://www.elastic.co/guide/en/kibana/master/spaces-api-get-all.html --- -# Data Source: elasticstack_kibana_spaces +# elasticstack_kibana_spaces (Data Source) -Use this data source to retrieve and get information about all existing Kibana spaces. +Use this data source to retrieve and get information about all existing Kibana spaces. See https://www.elastic.co/guide/en/kibana/master/spaces-api-get-all.html ## Example Usage diff --git a/docs/resources/apm_agent_configuration.md b/docs/resources/apm_agent_configuration.md index 8df89ceae..df99f512e 100644 --- a/docs/resources/apm_agent_configuration.md +++ b/docs/resources/apm_agent_configuration.md @@ -1,14 +1,15 @@ + --- -subcategory: "Kibana" -layout: "" -page_title: "Elasticstack: elasticstack_apm_agent_configuration Resource" +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_apm_agent_configuration Resource - terraform-provider-elasticstack" +subcategory: "APM" description: |- - Creates or updates an APM agent configuration + Creates or updates an APM agent configuration. See https://www.elastic.co/docs/solutions/observability/apm/apm-agent-central-configuration. --- -# Resource: elasticstack_apm_agent_configuration +# elasticstack_apm_agent_configuration (Resource) -Creates or updates an APM agent configuration. See https://www.elastic.co/docs/solutions/observability/apm/apm-agent-central-configuration +Creates or updates an APM agent configuration. See https://www.elastic.co/docs/solutions/observability/apm/apm-agent-central-configuration. ## Example Usage @@ -49,6 +50,8 @@ resource "elasticstack_apm_agent_configuration" "test_config" { Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_apm_agent_configuration.test_configuration my-service:production ``` diff --git a/docs/resources/elasticsearch_cluster_settings.md b/docs/resources/elasticsearch_cluster_settings.md index bd591363e..8c675c24c 100644 --- a/docs/resources/elasticsearch_cluster_settings.md +++ b/docs/resources/elasticsearch_cluster_settings.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_cluster_settings Resource - terraform-provider-elasticstack" subcategory: "Cluster" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_cluster_settings Resource" description: |- - Updates cluster-wide settings. + Updates cluster-wide settings. If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API. See the cluster settings documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html for more details. --- -# Resource: elasticstack_elasticsearch_cluster_settings +# elasticstack_elasticsearch_cluster_settings (Resource) -Updates cluster-wide settings. If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html +Updates cluster-wide settings. If the Elasticsearch security features are enabled, you must have the manage cluster privilege to use this API. See the [cluster settings documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html) for more details. ## Example Usage diff --git a/docs/resources/elasticsearch_component_template.md b/docs/resources/elasticsearch_component_template.md index 441232654..c835fa40d 100644 --- a/docs/resources/elasticsearch_component_template.md +++ b/docs/resources/elasticsearch_component_template.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_component_template Resource - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_component_template Resource" description: |- - Creates or updates a component template. + Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. See the component template documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html for more details. --- -# Resource: elasticstack_elasticsearch_component_template +# elasticstack_elasticsearch_component_template (Resource) -Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html +Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. See the [component template documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html) for more details. ## Example Usage @@ -64,14 +65,14 @@ Optional: - `alias` (Block Set) Alias to add. (see [below for nested schema](#nestedblock--template--alias)) - `mappings` (String) Mapping for fields in the index. Should be specified as a JSON object of field mappings. See the documentation (https://www.elastic.co/guide/en/elasticsearch/reference/current/explicit-mapping.html) for more details -- `settings` (String) Configuration options for the index. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings +- `settings` (String) Configuration options for the index. See the [index modules settings documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules.html#index-modules-settings) for more details. ### Nested Schema for `template.alias` Required: -- `name` (String) The alias name. Index alias names support date math. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/date-math-index-names.html +- `name` (String) The alias name. Index alias names support date math. See the [date math index names documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/date-math-index-names.html) for more details. Optional: @@ -108,6 +109,8 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_component_template.my_template / ``` diff --git a/docs/resources/elasticsearch_data_stream.md b/docs/resources/elasticsearch_data_stream.md index 6cfb9e88d..2402ab784 100644 --- a/docs/resources/elasticsearch_data_stream.md +++ b/docs/resources/elasticsearch_data_stream.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_data_stream Resource - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_data_stream Resource" description: |- - Manages Elasticsearch Data Streams + Managing Elasticsearch data streams, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-apis.html --- -# Resource: elasticstack_elasticsearch_data_stream +# elasticstack_elasticsearch_data_stream (Resource) -Manages data streams. This resource can create, delete and show the information about the created data stream. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-apis.html +Managing Elasticsearch data streams, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-apis.html ## Example Usage @@ -123,6 +124,8 @@ Read-Only: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_data_stream.my_data_stream / ``` diff --git a/docs/resources/elasticsearch_data_stream_lifecycle.md b/docs/resources/elasticsearch_data_stream_lifecycle.md index c06eb8096..cbb14db59 100644 --- a/docs/resources/elasticsearch_data_stream_lifecycle.md +++ b/docs/resources/elasticsearch_data_stream_lifecycle.md @@ -1,12 +1,13 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_data_stream_lifecycle Resource - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_data_stream_lifecycle Resource" description: |- - Manages Lifecycle for Elasticsearch Data Streams + Configures the data stream lifecycle for the targeted data streams, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-apis.html --- -# Resource: elasticstack_elasticsearch_data_stream_lifecycle +# elasticstack_elasticsearch_data_stream_lifecycle (Resource) Configures the data stream lifecycle for the targeted data streams, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/data-stream-apis.html @@ -105,6 +106,8 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_data_stream_lifecycle.my_data_stream_lifecycle / ``` diff --git a/docs/resources/elasticsearch_enrich_policy.md b/docs/resources/elasticsearch_enrich_policy.md index 1845fc54e..9e0a7ba52 100644 --- a/docs/resources/elasticsearch_enrich_policy.md +++ b/docs/resources/elasticsearch_enrich_policy.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_enrich_policy Resource - terraform-provider-elasticstack" subcategory: "Enrich" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_enrich_policy" description: |- - Managing Elasticsearch enrich policies, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html + Managing Elasticsearch enrich policies. See the enrich API documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html for more details. --- -# Resource: elasticstack_elasticsearch_enrich_policy +# elasticstack_elasticsearch_enrich_policy (Resource) -Creates or updates enrich policies, see: https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html +Managing Elasticsearch enrich policies. See the [enrich API documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html) for more details. ## Example Usage @@ -90,8 +91,10 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell # NOTE: while importing index resource, keep in mind, that some of the default index settings will be imported into the TF state too # You can later adjust the index configuration to account for those imported settings terraform import elasticstack_elasticsearch_enrich_policy.policy1 / -``` \ No newline at end of file +``` diff --git a/docs/resources/elasticsearch_index.md b/docs/resources/elasticsearch_index.md index da59dd302..15e5f3377 100644 --- a/docs/resources/elasticsearch_index.md +++ b/docs/resources/elasticsearch_index.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_index Resource - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_index Resource" description: |- - Creates or updates an index. + Creates Elasticsearch indices. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html --- -# Resource: elasticstack_elasticsearch_index +# elasticstack_elasticsearch_index (Resource) -Creates or updates an index. This resource can define settings, mappings and aliases. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html +Creates Elasticsearch indices. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html ## Example Usage @@ -190,13 +191,10 @@ Required: ## Import -**NOTE:** While importing index resource, keep in mind, that some of the default index settings will be imported into the TF state too. -You can later adjust the index configuration to account for those imported settings. - -Some of the default settings, which could be imported are: `index.number_of_replicas`, `index.number_of_shards` and `index.routing.allocation.include._tier_preference`. - Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell # NOTE: while importing index resource, keep in mind, that some of the default index settings will be imported into the TF state too # You can later adjust the index configuration to account for those imported settings diff --git a/docs/resources/elasticsearch_index_lifecycle.md b/docs/resources/elasticsearch_index_lifecycle.md index 99c241035..efbffa2ff 100644 --- a/docs/resources/elasticsearch_index_lifecycle.md +++ b/docs/resources/elasticsearch_index_lifecycle.md @@ -1,12 +1,13 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_index_lifecycle Resource - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_index_lifecycle Resource" description: |- - Creates or updates lifecycle policy. + Creates or updates lifecycle policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html --- -# Resource: elasticstack_elasticsearch_index_lifecycle +# elasticstack_elasticsearch_index_lifecycle (Resource) Creates or updates lifecycle policy. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html and https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-index-lifecycle.html @@ -434,6 +435,8 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_index_lifecycle.my_ilm / ``` diff --git a/docs/resources/elasticsearch_index_template.md b/docs/resources/elasticsearch_index_template.md index 08715c32e..e6cc51aa6 100644 --- a/docs/resources/elasticsearch_index_template.md +++ b/docs/resources/elasticsearch_index_template.md @@ -1,12 +1,13 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_index_template Resource - terraform-provider-elasticstack" subcategory: "Index" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_index_template Resource" description: |- - Creates or updates an index template. + Creates or updates an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html --- -# Resource: elasticstack_elasticsearch_index_template +# elasticstack_elasticsearch_index_template (Resource) Creates or updates an index template. Index templates define settings, mappings, and aliases that can be applied automatically to new indices. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html @@ -136,6 +137,8 @@ Required: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_index_template.my_template / ``` diff --git a/docs/resources/elasticsearch_ingest_pipeline.md b/docs/resources/elasticsearch_ingest_pipeline.md index 53f4c94dd..22d371057 100644 --- a/docs/resources/elasticsearch_ingest_pipeline.md +++ b/docs/resources/elasticsearch_ingest_pipeline.md @@ -1,24 +1,24 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_ingest_pipeline Resource - terraform-provider-elasticstack" subcategory: "Ingest" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_ingest_pipeline Resource" description: |- - Manages Ingest Pipelines + Manages tasks and resources related to ingest pipelines and processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-apis.html --- -# Resource: elasticstack_elasticsearch_ingest_pipeline +# elasticstack_elasticsearch_ingest_pipeline (Resource) -Use ingest APIs to manage tasks and resources related to ingest pipelines and processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-apis.html +Manages tasks and resources related to ingest pipelines and processors. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/ingest-apis.html ## Example Usage -You can provide your custom JSON definitions for the ingest processors: - ```terraform provider "elasticstack" { elasticsearch {} } +// You can provide the ingest pipeline processors as plain JSON objects. resource "elasticstack_elasticsearch_ingest_pipeline" "my_ingest_pipeline" { name = "my_ingest_pipeline" description = "My first ingest pipeline managed by Terraform" @@ -43,12 +43,8 @@ EOF , ] } -``` - -Or you can use data sources and Terraform declarative way of defining the ingest processors: - -```terraform +// Or you can use the provided data sources to create the processor data sources. data "elasticstack_elasticsearch_ingest_processor_set" "set_count" { field = "count" value = 1 @@ -69,7 +65,6 @@ resource "elasticstack_elasticsearch_ingest_pipeline" "ingest" { } ``` - ## Schema @@ -113,6 +108,8 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_ingest_pipeline.my_ingest_pipeline / ``` diff --git a/docs/resources/elasticsearch_logstash_pipeline.md b/docs/resources/elasticsearch_logstash_pipeline.md index bf7f49394..e89379a50 100644 --- a/docs/resources/elasticsearch_logstash_pipeline.md +++ b/docs/resources/elasticsearch_logstash_pipeline.md @@ -1,14 +1,15 @@ + --- +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_logstash_pipeline Resource - terraform-provider-elasticstack" subcategory: "Logstash" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_logstash_pipeline Resource" description: |- - Creates or updates centrally managed logstash pipelines. + Manage Logstash Pipelines via Centralized Pipeline Management. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-apis.html --- -# Resource: elasticstack_elasticsearch_logstash_pipeline +# elasticstack_elasticsearch_logstash_pipeline (Resource) -Creates or updates centrally managed logstash pipelines. See: https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-apis.html +Manage Logstash Pipelines via Centralized Pipeline Management. See, https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-apis.html ## Example Usage @@ -112,6 +113,8 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_logstash_pipeline.example / ``` diff --git a/docs/resources/elasticsearch_script.md b/docs/resources/elasticsearch_script.md index f551360af..d3996234b 100644 --- a/docs/resources/elasticsearch_script.md +++ b/docs/resources/elasticsearch_script.md @@ -1,14 +1,15 @@ + --- -subcategory: "Cluster" -layout: "" -page_title: "Elasticstack: elasticstack_elasticsearch_script Resource" +# generated by https://github.com/hashicorp/terraform-plugin-docs +page_title: "elasticstack_elasticsearch_script Resource - terraform-provider-elasticstack" +subcategory: "Elasticsearch" description: |- - Creates or updates a stored script or search template. + Creates or updates a stored script or search template. See the create stored script API documentation https://www.elastic.co/guide/en/elasticsearch/reference/current/create-stored-script-api.html for more details. --- -# Resource: elasticstack_elasticsearch_script +# elasticstack_elasticsearch_script (Resource) -Creates or updates a stored script or search template. See https://www.elastic.co/guide/en/elasticsearch/reference/current/create-stored-script-api.html +Creates or updates a stored script or search template. See the [create stored script API documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/create-stored-script-api.html) for more details. ## Example Usage @@ -85,6 +86,8 @@ Optional: Import is supported using the following syntax: +The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example: + ```shell terraform import elasticstack_elasticsearch_script.my_script /