Caroline f64e9dccb4
Restructure Data Prepper plugins documentation (#2073)
* Removed content from Data Prepper reference and broke out into separate pages.

Signed-off-by: carolxob <carolxob@amazon.com>

* Checking in file to make sure it's the right version.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor update.

Signed-off-by: carolxob <carolxob@amazon.com>

* Updated files.

Signed-off-by: carolxob <carolxob@amazon.com>

* Adding Sinks file.

Signed-off-by: carolxob <carolxob@amazon.com>

* Added file to PR.

Signed-off-by: carolxob <carolxob@amazon.com>

* Corrected TOC hierarchy.

Signed-off-by: carolxob <carolxob@amazon.com>

* Added images and reorganized files.

Signed-off-by: carolxob <carolxob@amazon.com>

* Reconfigured some content based on David's feedback.

Signed-off-by: carolxob <carolxob@amazon.com>

* Modified reference page.

Signed-off-by: carolxob <carolxob@amazon.com>

* Fixed minor heading issue.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits.

Signed-off-by: carolxob <carolxob@amazon.com>

* Major edits, files created, moved, and content broken out from main config page.

Signed-off-by: carolxob <carolxob@amazon.com>

* Adding key value and processors pages to the PR.

Signed-off-by: carolxob <carolxob@amazon.com>

* Basic ToC reorg.

Signed-off-by: carolxob <carolxob@amazon.com>

* ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor update.:

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor edits to ToC again.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor TOC update

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC edits.

Signed-off-by: carolxob <carolxob@amazon.com>

* Changed filename.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates

Signed-off-by: carolxob <carolxob@amazon.com>

* Making small Toc changes.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates.

Signed-off-by: carolxob <carolxob@amazon.com>

* Added comment blocks for Config and Metrics sections.

Signed-off-by: carolxob <carolxob@amazon.com>

* Minor ToC updates to add Sinks and Sources under config guide.

Signed-off-by: carolxob <carolxob@amazon.com>

Signed-off-by: carolxob <carolxob@amazon.com>
2022-12-27 14:58:48 -08:00

28 lines
920 B
Markdown

---
layout: default
title: rename_keys
parent: Processors
grand_parent: Configuring Data Prepper
nav_order: 44
---
# rename_keys
## Overview
Rename keys in an event. `rename_keys` is part of [mutate event](https://github.com/opensearch-project/data-prepper/tree/main/data-prepper-plugins/mutate-event-processors#mutate-event-processors) processors.
Option | Required | Type | Description
:--- | :--- | :--- | :---
entries | Yes | List | List of entries. Valid values are `from_key`, `to_key`, and `overwrite_if_key_exists`. Renaming occurs in the order defined.
from_key | N/A | N/A | The key of the entry to be renamed.
to_key | N/A | N/A | The new key of the entry.
overwrite_if_to_key_exists | No | Boolean | If true, the existing value gets overwritten if `to_key` already exists in the event.
<!---## Configuration
Content will be added to this section.
## Metrics
Content will be added to this section.--->