Fn::ToJsonString - AWS CloudFormation

Fn::ToJsonString

Fn::ToJsonString 組み込み関数は、オブジェクトまたは配列を対応する JSON 文字列に変換します。

重要

Fn::ToJsonString 組み込み関数を使用するには AWS::LanguageExtensions 変換を使用する必要があります。

宣言

JSON

{ "Fn::ToJsonString": Object }
{ "Fn::ToJsonString": Array }

YAML

Fn::ToJsonString: Object
Fn::ToJsonString: Array

パラメータ

Object

JSON 文字列に変換するオブジェクト。

Array

JSON 文字列に変換する配列。

戻り値

JSON 文字列に変換されたオブジェクトまたは配列。

オブジェクトを JSON 文字列に変換する

このサンプルスニペットは、組み込み関数に渡されたオブジェクトを JSON 文字列に変換します。

JSON

{ //... "Transform": "AWS::LanguageExtensions" //... "Fn::ToJsonString": { "key1": "value1", "key2": { "Ref": "ParameterName" } } //... }

YAML

Transform: 'AWS::LanguageExtensions' #... Fn::ToJsonString: key1: value1 key2: !Ref ParameterName #...

どちらの例でも、Ref から ParameterNameresolvedValue に解決される場合、この関数は次の JSON 文字列に解決されます。

"{\"key1\":\"value1\",\"key2\":\"resolvedValue\"}"

配列を JSON 文字列に変換する

このサンプルスニペットは、組み込み関数に渡された配列を JSON 文字列に変換します。

JSON

{ //... "Transform": "AWS::LanguageExtensions" //... "Fn::ToJsonString": [{ "key1": "value1", "key2": { "Ref": "ParameterName" } }] //... }

YAML

Transform: 'AWS::LanguageExtensions' #... Fn::ToJsonString: - key1: value1 key2: !Ref ParameterName #...

どちらの例でも、Ref から ParameterNameresolvedValue に解決される場合、この関数は次の JSON 文字列に解決されます。

"[{\"key1\":\"value1\"},{\"key2\":\"resolvedValue\"}]"

サポートされている関数

Fn::ToJsonString 組み込み関数または配列の中で、次の関数を使用できます。

  • Fn::Base64

  • Fn::FindInMap

  • Fn::GetAtt

  • Fn::GetAZs

  • Fn::If

  • Fn::ImportValue

  • Fn::Join

  • Fn::Length

  • Fn::Select

  • Fn::Split

  • Fn::Sub

  • Fn::ToJsonString

  • Ref