terraform/website/docs/language/functions/substr.html.md

layout	page_title	sidebar_current	description
language	substr - Functions - Configuration Language	docs-funcs-string-substr	The substr function extracts a substring from a given string by offset and length.

substr Function

substr extracts a substring from a given string by offset and length.

substr(string, offset, length)

Examples

> substr("hello world", 1, 4)
ello

The offset and length are both counted in unicode characters rather than bytes:

> substr("🤔🤷", 0, 1)
🤔

The offset index may be negative, in which case it is relative to the end of the given string. The length may be -1, in which case the remainder of the string after the given offset will be returned.

> substr("hello world", -5, -1)
world