Terraform の組み込み関数の一覧を簡単にまとめました。
より詳細な使い方やユースケースは公式ドキュメントをご参照ください。
動作環境
- Terraform v1.9.0
動作確認には主に terraform console を使用しています。
一部の出力結果は見やすいように整形等しています。
組み込み関数一覧
String Functions
Collection Functions
Encoding Functions
Filesystem Functions
Date and Time Functions
Hash and Crypto Functions
IP Network Functions
Type Conversion Functions
Terraform-specific Functions
Numeric Functions
abs
受け取った数値の絶対値を返します。
> abs(10)
10
> abs(-10)
10
> abs(0)
0
ceil
受け取った数値の少数点以下を切り上げた整数を返します。
> ceil(1.1)
2
> ceil(1.9)
2
> ceil(1)
1
floor
受け取った数値の少数点以下を切り捨てた整数を返します。
> floor(1.1)
1
> floor(1.9)
1
> floor(1)
1
log
受け取った数値の対数を指定した底で計算した結果を返します。
# 10 を底とする 100 の対数
> log(100, 10)
2
# 2 を底とする 100 の対数
> log(100, 2)
6.643856189774725
max
受け取った数値のうち、最大の数値を返します。
> max(1)
1
> max(1, 100)
100
> max(1, 100, 3)
100
min
受け取った数値のうち、最小の数値を返します。
> min(1)
1
> min(1, 100)
1
> min(1, 100, 3)
1
parseint
受け取った文字列を指定した基数で解釈した数値を返します。
# "10" を 10 進数として解釈
> parseint("10", 10)
10
# "FF" を 16 進数として解釈
> parseint("FF", 16)
255
# "100" を 2 進数として解釈
> parseint("100", 2)
4
pow
受け取った基数を指定した指数で累乗した結果を返します。
# 2 の 3 乗
> pow(2, 3)
8
# 10 の 2 乗
> pow(10, 2)
100
signum
受け取った数値の符号 ( 1, 0, -1 ) を返します。
# 正の数のときは 1
> signum(10)
1
# 0 のときは 0
> signum(0)
0
# 負の数のときは -1
> signum(-10)
-1
String Functions
chompendswithformatformatlistindentjoinlowerregexregexallreplacesplitstartswithstrcontainsstrrevsubstrtemplatestringtitletrimtrimprefixtrimsuffixtrimspaceupper
chomp
受け取った文字列の末尾の改行文字を削除して返します。
> chomp("hello\n")
"hello"
> chomp("hello\r\n")
"hello"
> chomp("hello\n\n\n")
"hello"
> chomp("hello")
"hello"
endswith
受け取った文字列が指定した文字列で終わっているかどうかを返します。
> endswith("hello world", "world")
true
> endswith("hello world", "hello")
false
format
受け取ったフォーマット文字列に従って文字列を生成します。
> format("Hello, %s", "world")
"Hello, world"
> format("Hello, %s %d", "world", 2022)
"Hello, world 2022"
formatlist
リストの各要素に対してフォーマット文字列に従って文字列を生成します。
> formatlist("Hello, %s", ["a", "b", "c"])
[
"Hello, a",
"Hello, b",
"Hello, c",
]
indent
複数行の文字列に対して、最初の行を除く全ての行の先頭に指定した数のスペースを追加して返します。
# 2 行目以降に 2 つのスペースが追加される
> indent(2, "first\nsecond\nthird")
first
second
third
join
指定した区切り文字でリストの各要素を連結した文字列を返します。
> join(",", ["a", "b", "c"])
"a,b,c"
> join(",", ["a"])
"a"
lower
受け取った文字列を全て小文字に変換して返します。
> lower("HELLO")
"hello"
> lower("Hello")
"hello"
regex
正規表現に一致する部分文字列を返します。
> regex("[a-z]+", "abc123")
"abc"
> regex("[a-z]+", "abc123def")
"abc"
> regex("(\\d{4})-(\\d{2})-(\\d{2})", "2022-01-01")
[
"2022",
"01",
"01",
]
regexall
正規表現に一致する部分文字列のリストを返します。
> regexall("[a-z]+", "abc123")
[
"abc",
]
> regexall("[a-z]+", "abc123def")
[
"abc",
"def",
]
> regexall("(\\d{4})-(\\d{2})-(\\d{2})", "2022-01-01")
[
[
"2022",
"01",
"01",
],
]
replace
指定した文字列を別の文字列に置換して返します。
> replace("hello world", "world", "terraform")
"hello terraform"
> replace("hello world", " world", "")
"hello"
split
指定した区切り文字で文字列を分割したリストを返します。
> split(",", "a,b,c")
[
"a",
"b",
"c",
]
> split(",", "a")
[
"a",
]
startswith
受け取った文字列が指定した文字列で始まっているかどうかを返します。
> startswith("hello world", "hello")
true
> startswith("hello world", "world")
false
strcontains
受け取った文字列が指定した文字列を含んでいるかどうかを返します。
> strcontains("hello world", "world")
true
> strcontains("hello world", "terraform")
false
strrev
受け取った文字列を逆順にして返します。
> strrev("hello")
"olleh"
substr
指定した位置から指定した長さの部分文字列を返します。
# 0 番目から 5 文字目までの部分文字列を返す
> substr("hello world", 0, 5)
"hello"
# 6 番目から 5 文字目までの部分文字列を返す
> substr("hello world", 6, 5)
"world"
templatestring
指定した文字列をテンプレートとして解釈し、変数を展開した文字列を返します。
locals {
template = "hello, $${name}"
}
output "result" {
value = templatestring(local.template, { name = "world" })
# => "hello, world"
}
文字列リテラルを直接テンプレートとして渡すことはできません。
> templatestring("hello, $${name}", { name = "world" })
╷
│ Error: Invalid function argument
│
│ on <console-input> line 1:
│ (source code not available)
│
│ Invalid value for "template" parameter: invalid template expression: templatestring is only for rendering templates
│ retrieved dynamically from elsewhere, and so does not support providing a literal template; consider using a
│ template string expression instead.
╵
title
受け取った文字列の各単語の先頭文字を大文字にして返します。
> title("hello world")
"Hello World"
trim
受け取った文字列の両端から指定した文字列を削除して返します。
> trim(" hello world ", " ")
"hello world"
> trim("!?hello world?!", "!?")
"hello world"
trimprefix
受け取った文字列の先頭から指定した文字列を削除して返します。
> trimprefix("hello world", "hello ")
"world"
trimsuffix
受け取った文字列の末尾から指定した文字列を削除して返します。
> trimsuffix("hello world", " world")
"hello"
trimspace
受け取った文字列の両端から空白文字を削除して返します。
> trimspace(" hello world\n\t")
"hello world"
upper
受け取った文字列を全て大文字にして返します。
> upper("hello world")
"HELLO WORLD"
Collection Functions
alltrueanytruechunklistcoalescecoalescelistcompactconcatcontainsdistinctelementflattenindexkeyslengthlistlookupmapmatchkeysmergeonerangereversesetintersectionsetproductsetsubtractsetunionslicesortsumtransposevalueszipmap
alltrue
受け取ったリストの全ての要素が true もしくは "true" である場合に true を返します。
> alltrue([true, "true", true])
true
> alltrue([true, false, true])
false
# 空のリストは true を返す
> alltrue([])
true
anytrue
受け取ったリストのいずれかの要素が true もしくは "true" である場合に true を返します。
> anytrue([true, false, false])
true
> anytrue(["true", false, false])
true
> anytrue([false, false, false])
false
# 空のリストは false を返す
> anytrue([])
false
chunklist
受け取ったリストを指定したサイズで分割して返します。
> chunklist(["a", "b", "c", "d", "e"], 2)
[
[
"a",
"b",
],
[
"c",
"d",
],
[
"e",
],
]
> chunklist(["a", "b", "c", "d", "e"], 1)
[
[
"a",
],
[
"b",
],
[
"c",
],
[
"d",
],
[
"e",
],
]
coalesce
受け取った値のうち、 "" ( 空文字 ) でも null でもない最初の値を返します。
> coalesce("a", "b", "c")
"a"
> coalesce("", "b", "c")
"b"
> coalesce("", null, "c")
"c"
> coalesce(null, 1, 2)
1
coalescelist
受け取ったリストのうち、空でない最初のリストを返します。
> coalescelist(["a", "b"], ["c", "d"])
[
"a",
"b",
]
> coalescelist([], ["c", "d"])
[
"c",
"d",
]
compact
受け取った文字列リストから "" ( 空文字 ) や null を削除して返します。
> compact(["a", "", "b", null, "c"])
[
"a",
"b",
"c",
]
concat
受け取ったリストを結合して返します。
> concat(["a", "b"], ["c", "d"])
[
"a",
"b",
"c",
"d",
]
contains
受け取ったリストに指定した値が含まれている場合に true を返します。
> contains(["a", "b", "c"], "b")
true
> contains(["a", "b", "c"], "d")
false
distinct
受け取ったリストから重複する要素を削除して返します。
> distinct(["a", "b", "a", "c", "b"])
[
"a",
"b",
"c",
]
> distinct([1, 2, 1, 3, 2])
[
1,
2,
3,
]
element
受け取ったリストから指定したインデックスの要素を返します。
> element(["a", "b", "c"], 0)
"a"
> element(["a", "b", "c"], 1)
"b"
flatten
受け取ったリストを平坦化して返します。
> flatten([["a", "b"], ["c", "d"]])
[
"a",
"b",
"c",
"d",
]
index
受け取ったリストから指定した値のインデックスを返します。
見つからなかった場合はエラーになります。
> index(["a", "b", "c"], "b")
1
> index(["a", "b", "c"], "d")
╷
│ Error: Error in function call
│
│ on <console-input> line 1:
│ (source code not available)
│
│ Call to function "index" failed: item not found.
╵
keys
受け取ったマップのキーのリストを返します。
> keys({ a = 1, b = 2, c = 3 })
[
"a",
"b",
"c",
]
length
受け取ったリストの長さを返します。
> length([])
0
> length(["a", "b", "c"])
3
list
現在は使用できません。
lookup
受け取ったマップから指定したキーの値を返します。
> lookup({ a = 1, b = 2, c = 3 }, "b")
2
# キーが見つからなかったときのデフォルト値を指定できる
> lookup({ a = 1, b = 2, c = 3 }, "d", "default")
"default"
map
現在は使用できません。
matchkeys
受け取った複数のリストから対応するインデックスが一致する要素のサブセットを取り、新しいリストを作成して返します。
> matchkeys(["a", "b", "c"], ["x", "y", "z"], ["y", "z"])
[
"b",
"c",
]
merge
受け取った複数のマップをマージして返します。
> merge({ a = 1, b = 2 }, { b = 3, c = 4 })
{
"a" = 1
"b" = 3
"c" = 4
}
one
受け取ったリストの最初の要素を返します。
リストが空の場合は null を返し、要素が 2 つ以上ある場合はエラーになります。
> one([1])
1
> one([])
null
> one([1, 2])
╷
│ Error: Invalid function argument
│
│ on <console-input> line 1:
│ (source code not available)
│
│ Invalid value for "list" parameter: must be a list, set, or tuple value with either zero or one elements.
╵
range
指定した範囲の整数のリストを返します。
> range(3)
[
0,
1,
2,
]
> range(1, 4)
[
1,
2,
3,
]
# ステップを指定することもできる
> range(1, 6, 2)
[
1,
3,
5,
]
reverse
受け取ったリストを逆順にして返します。
> reverse(["a", "b", "c"])
[
"c",
"b",
"a",
]
setintersection
受け取った複数のセットの共通部分を返します。
> setintersection(["a", "b", "c"], ["b", "c", "d"])
[
"b",
"c",
]
> setintersection(["a", "b", "c"], ["b", "c", "d"], ["c", "d", "e"])
[
"c",
]
setproduct
受け取った複数のセットの直積を返します。
> setproduct(["a", "b"], ["1", "2"])
[
[
"a",
"1",
],
[
"a",
"2",
],
[
"b",
"1",
],
[
"b",
"2",
],
]
setsubtract
最初のセットから 2 番目のセットの要素を取り除いたセットを返します。
> setsubtract(["a", "b", "c"], ["a", "c"])
[
"b",
]
setunion
受け取った複数のセットを結合して返します。
> setunion(["a", "b"], ["b", "c"], ["c", "d"])
[
"a",
"b",
"c",
"d",
]
slice
指定した範囲の要素を取り出して新しいリストを返します。
> slice(["a", "b", "c", "d"], 1, 3)
[
"b",
"c",
]
sort
受け取った文字列リストをソートして返します。
> sort(["c", "a", "b"])
[
"a",
"b",
"c",
]
sum
受け取った数値リストの合計を返します。
> sum([1, 2, 3])
6
transpose
受け取った文字列リストのマップのキーと値を入れ替えて返します。
> transpose({ a = ["1", "2"], b = ["2", "3"] })
{
"1" = [
"a",
]
"2" = [
"a",
"b",
]
"3" = [
"b",
]
}
values
受け取ったマップの値のリストを返します。
> values({ a = 1, b = 2 })
[
1,
2,
]
zipmap
キーのリストと値のリストを受け取り、マップに変換して返します。
> zipmap(["a", "b"], [1, 2])
{
"a" = 1
"b" = 2
}
Encoding Functions
base64decodebase64encodebase64gzipcsvdecodejsondecodejsonencodetextdecodebase64textencodebase64urlencodeyamldecodeyamlencode
base64decode
受け取った Base64 エンコードされた文字列をデコードして返します。
> base64decode("SGVsbG8gV29ybGQ=")
"Hello World"
base64encode
受け取った文字列を Base64 エンコードして返します。
> base64encode("Hello World")
"SGVsbG8gV29ybGQ="
base64gzip
受け取った文字列を GZIP 圧縮して Base64 エンコードして返します。
> base64gzip("Hello World")
"H4sIAAAAAAAA//JIzcnJVwjPL8pJAQAAAP//AQAA//9WsRdKCwAAAA=="
csvdecode
受け取った CSV 形式の文字列をデコードして返します。
> csvdecode("a,b,c\n1,2,3\n4,5,6")
[
{
"a" = "1"
"b" = "2"
"c" = "3"
},
{
"a" = "4"
"b" = "5"
"c" = "6"
},
]
jsondecode
受け取った JSON 形式の文字列をデコードして返します。
> jsondecode("{\"a\": 1, \"b\": 2}")
{
"a" = 1
"b" = 2
}
jsonencode
受け取った値を JSON 形式の文字列にエンコードして返します。
> jsonencode({ a = 1, b = 2 })
"{\"a\":1,\"b\":2}"
textdecodebase64
Base64 エンコードされた文字列をデコードして返します。
デコード後の文字列は指定した文字コードでエンコードされているものとして扱われます。
> textdecodebase64("SABlAGwAbABvACAAVwBvAHIAbABkAA==", "UTF-16LE")
"Hello World"
textencodebase64
受け取った文字列を Base64 エンコードして返します。
エンコード後の文字列は指定した文字コードでエンコードされているものとして扱われます。
> textencodebase64("Hello World", "UTF-16LE")
"SABlAGwAbABvACAAVwBvAHIAbABkAA=="
urlencode
受け取った文字列を URL エンコードして返します。
> urlencode("Hello World")
"Hello+World"
> urlencode("こんにちは")
"%E3%81%93%E3%82%93%E3%81%AB%E3%81%A1%E3%81%AF"
yamldecode
受け取った YAML 形式の文字列をデコードして返します。
> yamldecode("a: 1\nb: 2")
{
"a" = 1
"b" = 2
}
yamlencode
受け取った値を YAML 形式の文字列にエンコードして返します。
> yamlencode({ a = 1, b = 2 })
"a": 1
"b": 2
Filesystem Functions
abspath
指定したパスを絶対パスに変換して返します。
> abspath("foo/bar")
"/Users/username/foo/bar"
> abspath("/foo/bar")
"/foo/bar"
dirname
指定したパスのディレクトリ部分を返します。
> dirname("foo/bar")
"foo"
> dirname("foo/bar/")
"foo/bar"
> dirname("foo/bar/hoge")
"foo/bar"
pathexpand
~ で始まるパスをユーザーのホームディレクトリに展開して返します。
> pathexpand("~/foo")
"/Users/username/foo"
> pathexpand("foo/bar")
"foo/bar"
basename
指定したパスのベース名を返します。
> basename("foo/bar")
"bar"
> basename("foo/bar/")
"bar"
> basename("foo/bar/hoge")
"hoge"
file
指定したファイルの内容を返します。
> file("foo.txt")
"Hello World"
fileexists
指定したファイルが存在するかどうかを返します。
> fileexists("foo.txt")
true
> fileexists("bar.txt")
false
fileset
指定したパスとパターンに一致するファイル名のリストを返します。
> fileset(path.module, "*.txt")
[
"foo.txt",
"bar.txt"
]
> fileset(path.module, "files/*.txt")
[
"files/foo.txt",
"files/bar.txt"
]
filebase64
指定したファイルの内容を Base64 エンコードして返します。
> filebase64("foo.txt")
"SGVsbG8gV29ybGQ="
templatefile
指定したファイルをテンプレートとして処理し、変数を埋め込んだ結果を返します。
Hello ${name}
> templatefile("hello.tpl", { name = "World" })
"Hello World"
Date and Time Functions
formatdate
指定したフォーマットで日付をフォーマットして返します。
> formatdate("YYYY-MM-DD", "1998-01-31T09:30:20Z")
"1998-01-31"
> formatdate("YYYY-MM-DD hh:mm:ss", "1998-01-31T09:30:20Z")
"1998-01-31 09:30:20"
plantimestamp
terraform plan 実行時のタイムスタンプを返します。
output "result" {
value = plantimestamp()
# => "2024-06-29T12:01:11Z"
}
timeadd
指定した時間を加算して返します。
> timeadd("2021-09-01T00:00:00Z", "30m")
"2021-09-01T00:30:00Z"
> timeadd("2021-09-01T00:00:00Z", "1h")
"2021-09-01T01:00:00Z"
timecmp
指定した時間を比較して返します。
# 0: 同じ
> timecmp("2021-09-01T00:00:00Z", "2021-09-01T00:00:00Z")
0
# -1: 左の方が過去
> timecmp("2021-09-01T00:00:00Z", "2021-09-01T00:30:00Z")
-1
# 1: 右の方が過去
> timecmp("2021-09-01T00:30:00Z", "2021-09-01T00:00:00Z")
1
timestamp
現在のタイムスタンプを返します。
> timestamp()
"2024-06-29T08:29:27Z"
Hash and Crypto Functions
base64sha256base64sha512bcryptfilebase64sha256filebase64sha512filemd5filesha1filesha256filesha512md5rsadecryptsha1sha256sha512uuiduuidv5
base64sha256
指定した文字列の SHA-256 ハッシュを Base64 エンコードして返します。
> base64sha256("hello world")
"uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek="
base64sha512
指定した文字列の SHA-512 ハッシュを Base64 エンコードして返します。
> base64sha512("hello world")
"MJ7MSJwS1utMxA9QyQLytNDtd+5RGnx6m808qG1M2G+YndNbxf9JlnDaNCVbRbDP2DDoH2Bdz33FVC6TrpzXbw=="
bcrypt
指定した文字列を bcrypt でハッシュ化して返します。
> bcrypt("hello world")
"$2a$10$LF99X3qgYdtk.zsymxga5eXBy33fW0MbwEwhO3IOgcQzsNbGWIEzm"
# コストを指定することもできる (デフォルトは 10)
> bcrypt("hello world", 12)
"$2a$12$AY/ORDQ7ELYk0AybyMZJVuMq9239wNindxx73wb1KxaGCRXtMFQgO"
filebase64sha256
指定したファイルの内容の SHA-256 ハッシュを Base64 エンコードして返します。
> filebase64sha256("foo.txt")
"uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek="
filebase64sha512
指定したファイルの内容の SHA-512 ハッシュを Base64 エンコードして返します。
> filebase64sha512("foo.txt")
"LHT9F+2v2A6ER7DUZ0HuJDt+t03SFJoKsbkkb7MDgvJ+hT2FhXGeDmfL2g2qj1FnEGRhXWRa4nrLFb+xRH9Fmw=="
filemd5
指定したファイルの内容の MD5 ハッシュを返します。
> filemd5("foo.txt")
"b10a8db164e0754105b7a99be72e3fe5"
filesha1
指定したファイルの内容の SHA-1 ハッシュを返します。
> filesha1("foo.txt")
"0a4d55a8d778e5022fab701977c5d840bbc486d0"
filesha256
指定したファイルの内容の SHA-256 ハッシュを返します。
> filesha256("foo.txt")
"a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e"
filesha512
指定したファイルの内容の SHA-512 ハッシュを返します。
> filesha512("foo.txt")
"2c74fd17edafd80e8447b0d46741ee243b7eb74dd2149a0ab1b9246fb30382f27e853d8585719e0e67cbda0daa8f51671064615d645ae27acb15bfb1447f459b"
md5
指定した文字列の MD5 ハッシュを返します。
> md5("Hello World")
"b10a8db164e0754105b7a99be72e3fe5"
rsadecrypt
指定した RSA 秘密鍵で暗号化されたデータを復号します。
> rsadecrypt(filebase64("foo.txt.enc"), file("private_key.pem"))
"Hello World"
sha1
指定した文字列の SHA-1 ハッシュを返します。
> sha1("Hello World")
"0a4d55a8d778e5022fab701977c5d840bbc486d0"
sha256
指定した文字列の SHA-256 ハッシュを返します。
> sha256("Hello World")
"a591a6d40bf420404a011733cfb7b190d62c65bf0bcda32b57b277d9ad9f146e"
sha512
指定した文字列の SHA-512 ハッシュを返します。
> sha512("Hello World")
"2c74fd17edafd80e8447b0d46741ee243b7eb74dd2149a0ab1b9246fb30382f27e853d8585719e0e67cbda0daa8f51671064615d645ae27acb15bfb1447f459b"
uuid
ランダムな UUID を生成します。
> uuid()
"48672f02-9d83-b4f9-d0fb-46fb946122bc"
uuidv5
指定した名前と名前空間から生成された UUID を返します。
> uuidv5("dns", "www.terraform.io")
"a5008fae-b28c-5ba5-96cd-82b4c53552d6"
> uuidv5("url", "https://www.terraform.io/")
"9db6f67c-dd95-5ea0-aa5b-e70e5c5f7cf5"
IP Network Functions
cidrhost
CIDR ブロック内の指定したホストの IP アドレスを返します。
> cidrhost("10.12.112.0/20", 16)
"10.12.112.16"
> cidrhost("10.12.112.0/20", 268)
"10.12.113.12"
cidrnetmask
指定した CIDR ブロックのネットワークマスクを返します。
> cidrnetmask("172.16.0.0/12")
"255.240.0.0"
cidrsubnet
指定した CIDR ブロック内の指定したサブネットの CIDR ブロックを返します。
> cidrsubnet("172.16.0.0/12", 4, 2)
"172.18.0.0/16"
> cidrsubnet("10.1.2.0/24", 4, 15)
"10.1.2.240/28"
> cidrsubnet("fd00:fd12:3456:7890::/56", 16, 162)
"fd00:fd12:3456:7800:a200::/72"
cidrsubnets
指定した CIDR ブロック内の連続したサブネットの CIDR ブロックのリストを返します。
> cidrsubnets("10.1.0.0/16", 4)
[
"10.1.0.0/20",
]
> cidrsubnets("10.1.0.0/16", 4, 4)
[
"10.1.0.0/20",
"10.1.16.0/20",
]
> cidrsubnets("10.1.0.0/16", 4, 4, 8, 4)
[
"10.1.0.0/20",
"10.1.16.0/20",
"10.1.32.0/24",
"10.1.48.0/20",
]
> cidrsubnets("fd00:fd12:3456:7890::/56", 16, 16, 16, 32)
[
"fd00:fd12:3456:7800::/72",
"fd00:fd12:3456:7800:100::/72",
"fd00:fd12:3456:7800:200::/72",
"fd00:fd12:3456:7800:300::/88",
]
Type Conversion Functions
can
指定した Expression がエラーを返さずに評価されるかどうかを返します。
> can(tonumber("invalid"))
false
> can(tonumber("1"))
true
issensitive
指定した値が sensitive かどうかを返します。
> issensitive("hello")
false
> issensitive(sensitive("secret"))
true
nonsensitive
指定した値を sensitive でない値に変換します。
> sensitive("secret")
(sensitive value)
> nonsensitive(sensitive("secret"))
"secret"
sensitive
指定した値を sensitive な値に変換します。
> sensitive("secret")
(sensitive value)
tobool
指定した値を bool に変換します。
> tobool("true")
true
> tobool("false")
false
> tobool(null)
null
tolist
指定した値をリストに変換します。
> tolist([1, 2, 3])
[
1,
2,
3,
]
tomap
指定した値をマップに変換します。
> tomap({ a = 1, b = 2, c = 3 })
{
"a" = 1
"b" = 2
"c" = 3
}
tonumber
指定した値を数値に変換します。
> tonumber("1")
1
> tonumber(null)
null
toset
指定した値をセットに変換します。
> toset([1, 1, 2, 2, 3, 3])
[
1,
2,
3,
]
tostring
指定した値を文字列に変換します。
> tostring(1)
"1"
> tostring(true)
"true"
> tostring(null)
null
try
指定した Expression を順番に評価し、エラーを返さなかった最初の Expression の結果を返します。
> try(tonumber("invalid"), "default")
"default"
> try(tonumber("1"), "default")
1
type
指定した値の型を返します。
terraform console でのみ使用可能です。
> type(1)
number
> type("hello")
string
> type(true)
bool
Terraform-specific Functions
provider::terraform::encode_tfvarsprovider::terraform::decode_tfvarsprovider::terraform::encode_expr
これらの関数は Terraform 組み込みのプロバイダーから提供される Provider-defined Functions です。
使用するためには required_providers 内に terraform.io/builtin/terraform を明示的に指定する必要があります。
terraform {
required_providers {
terraform = {
source = "terraform.io/builtin/terraform"
}
}
}
Provider-defined Functions については以下の記事をご参照ください。
provider::terraform::encode_tfvars
受け取ったオブジェクトを .tfvars ファイル形式の文字列にエンコードします。
> provider::terraform::encode_tfvars({ example = 1 })
"example = 1"
provider::terraform::decode_tfvars
.tfvars ファイル形式の文字列をオブジェクトにデコードします。
> provider::terraform::decode_tfvars("example = 1")
{
"example" = 1
}
provider::terraform::encode_expr
受け取った値を Terraform 言語の式構文の文字列にエンコードします。
> provider::terraform::encode_expr(1)
"1"
> provider::terraform::encode_expr("hello")
"\"hello\""
まとめ
色々ありますね〜。
Discussion