Craig Adam 9c4e13bd2e
Fix missing character typo (#5771)
* Fix missing character typo

Signed-off-by: Craig Adam <craig@adam11.ca>

* Update substitute-string.md

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Craig Adam <craig@adam11.ca>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2023-12-04 12:27:39 -06:00

1.1 KiB

layout title parent grand_parent nav_order
default substitute_string Processors Pipelines 110

substitute_string

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.

Configuration

The following table describes the options you can use to configure the substitute_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.