mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-01-05 13:00:26 -05:00
39 lines
1.2 KiB
Markdown
39 lines
1.2 KiB
Markdown
---
|
|
layout: "functions"
|
|
page_title: "replace - Functions - Configuration Language"
|
|
sidebar_current: "docs-funcs-string-replace"
|
|
description: |-
|
|
The replace function searches a given string for another given substring,
|
|
and replaces all occurrences with a given replacement string.
|
|
---
|
|
|
|
# `replace` Function
|
|
|
|
-> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and
|
|
earlier, see
|
|
[0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html).
|
|
|
|
`replace` searches a given string for another given substring, and replaces
|
|
each occurrence with a given replacement string.
|
|
|
|
```hcl
|
|
replace(string, substring, replacement)
|
|
```
|
|
|
|
If `substring` is wrapped in forward slashes, it is treated as a regular
|
|
expression; the syntax conforms to the [re2 regular expression
|
|
syntax](https://github.com/google/re2/wiki/Syntax) syntax. If using a regular
|
|
expression for the substring argument, the `replacement` string can incorporate
|
|
captured strings from the input by using an `$n` sequence, where `n` is the
|
|
index or name of a capture group.
|
|
|
|
## Examples
|
|
|
|
```
|
|
> replace("1 + 2 + 3", "+", "-")
|
|
1 - 2 - 3
|
|
|
|
> replace("hello world", "/w.*d/", "everybody")
|
|
hello everybody
|
|
```
|