Moves the generic sink options into the Sinks documentation rather th…

…an PIpeline Configuration options. (opensearch-project#4907) Signed-off-by: David Venable <[email protected]> Signed-off-by: sheltie <[email protected]>
sheltie-fusafusa · Aug 28, 2023 · 32e381f · 32e381f
1 parent 4b02018
commit 32e381f
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 15 deletions.
diff --git a/_data-prepper/pipelines/configuration/sinks/sinks.md b/_data-prepper/pipelines/configuration/sinks/sinks.md
@@ -14,6 +14,9 @@ Sinks define where Data Prepper writes your data to.
 
 The following table describes options you can use to configure the `sinks` sink.
 
-Option | Required | Type | Description
-:--- | :--- | :--- | :---
-routes | No | List | List of routes that the sink accepts. If not specified, the sink accepts all upstream events.
+Option | Required | Type        | Description
+:--- | :--- |:------------| :---
+routes | No | String list | A list of routes for which this sink applies. If not provided, this sink receives all events. See [conditional routing]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/pipelines#conditional-routing) for more information.
+tags_target_key | No | String   | When specified, includes event tags in the output of the provided key.
+include_keys | No | String list | When specified, provides the keys in this list in the data sent to the sink.
+exclude_keys | No | String list | When specified, excludes the keys given from the data sent to the sink.
diff --git a/_data-prepper/pipelines/pipelines-configuration-options.md b/_data-prepper/pipelines/pipelines-configuration-options.md
@@ -16,15 +16,3 @@ Option | Required | Type | Description
 workers | No | Integer | Essentially the number of application threads. As a starting point for your use case, try setting this value to the number of CPU cores on the machine. Default is 1.
 delay | No | Integer | Amount of time in milliseconds workers wait between buffer read attempts. Default is `3000`.
 
-
-## General sink options
-
-The following options are available for all sinks.
-
-Option | Required | Type        | Description
-:--- | :--- |:------------| :---
-routes | No | String list | A list of routes for which this sink applies. If not provided, this sink receives all events. See [conditional routing]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/pipelines#conditional-routing) for more information.
-tags_target_key | No | String   | When specified, includes event tags in the output of the provided key.
-include_keys | No | String list | When specified, provides the keys in this list in the data sent to the sink.
-exclude_keys | No | String list | When specified, excludes the keys given from the data sent to the sink.
-