opensearch-docs-cn/_data-prepper/pipelines/configuration/processors/substitute-string.md

1.2 KiB

layout title parent grand_parent nav_order
default substitute_string Processors Pipelines 45

substitute_string

Overview

The substitute_string processor matches a key's value against a regular expression and replaces all matches with a replacement string. substitute_string is a mutate string processor. The following table describes the options you can use to configure the substitue_string processor.

Option Required Type Description
entries Yes List List of entries. Valid values are source, from, and to.
source N/A N/A The key to modify.
from N/A N/A The Regex String to be replaced. Special regex characters such as [ and ] must be escaped using \\ when using double quotes and \ when using single quotes. See Java Patterns for more information.
to N/A N/A The String to be substituted for each match of from.