すべてのプロダクト
Search
ドキュメントセンター

Resource Orchestration Service:関数インデックス

最終更新日:Jan 16, 2025

Resource Orchestration Service ( ROS ) は、スタックの管理に役立つさまざまな組み込み関数を提供します。組み込み関数は、[Resources] セクションと [Outputs] セクションで使用できます。このトピックでは、ROS でサポートされている組み込み関数について説明します。

考慮事項

YAML を使用して短構文形式で関数を定義し、別の関数を使用して関数のパラメーター値を指定する場合、少なくとも 1 つの関数を完全構文形式で定義する必要があります。そうしないと、関数は無効になります。

  • 次の構文形式の関数は無効です。

    !Base64Encode !Sub string
    !Base64Encode !Ref logical_ID
    // 無効な関数
  • 次の構文形式の関数は有効です。

    !Base64Encode
     "Fn::Sub": string
    // 有効な関数
    
    Fn::Base64Encode:
     !Sub string
    // 有効な関数

サポートされている関数

関数

説明

Fn::Base64Encode

文字列の Base64 エンコード形式を返します。

Fn::Base64Decode

Base64 エンコードされた文字列からデコードされた文字列を返します。

Fn::Str

数値の文字列形式を返します。

Fn::Indent

文字列のインデント形式を調整します。

Fn::FindInMap

[Mappings] セクションで宣言されている 2 レベルのマッピングのキーに対応する値を返します。

Fn::GetAtt

テンプレートからリソースのプロパティ値を返します。

Fn::Join

一連の文字列を、区切り文字で区切られた単一の文字列に結合します。

Fn::Sub

文字列内の変数を、指定した値で置き換えます。

Fn::Select

インデックスに基づいて、リストまたは辞書からデータ要素を返します。

Ref

パラメーターまたはリソースの値を参照します。

Fn::GetAZs

リージョンに属するゾーンのリストを返します。

Fn::Replace

文字列内の部分文字列を別の部分文字列に置き換えます。

Fn::Split

区切り文字を使用して文字列を複数の値に分割します。

Fn::Equals

2 つの値を比較して、等しいかどうかを確認します。2 つの値が等しい場合は true が返されます。2 つの値が等しくない場合は false が返されます。

Fn::And

AND 演算子を表し、少なくとも 2 つの条件を含める必要があります。指定されたすべての条件が true と評価された場合は true が返されます。条件が false と評価された場合は false が返されます。

Fn::Or

OR 演算子を表し、少なくとも 2 つの条件を含める必要があります。条件が true と評価された場合は true が返されます。指定されたすべての条件が false と評価された場合は false が返されます。

Fn::Not

NOT 演算子を表します。条件が false と評価された場合は true が返されます。条件が true と評価された場合は false が返されます。

Fn::Index

リスト内の要素のインデックスを照会します。

Fn::If

2 つの可能な値のいずれかを返します。指定された条件が true と評価された場合は 1 つの値が返され、そうでない場合は別の値が返されます。テンプレートの [Resources] セクションと [Outputs] セクションのプロパティ値は、組み込み関数 Fn::If をサポートしています。擬似パラメーター ALIYUN::NoValue を戻り値として使用して、プロパティを削除できます。

Fn::Length

オブジェクト内の要素の数を返します。

Fn::ListMerge

複数のリストを 1 つのリストにマージします。

Fn::GetJsonValue

JSON 文字列を解決し、最初のレイヤーからキーの値を照会します。

Fn::MergeMapToList

複数のマッピングを新しいマッピングリストにマージします。

Fn::Avg

一連の数値の平均値を返します。

Fn::SelectMapList

マップのリストから値を返します。

Fn::Add

パラメーターの合計を計算します。

Fn::Calculate

文字列型の式の計算結果を返します。

Fn::Max

数値のリストから最大の数値を返します。

Fn::Min

数値のリストから最小の数値を返します。

Fn::GetStackOutput

スタックの出力を照会します。

Fn::Jq

jq 機能をサポートします。 jq 機能の詳細については、「jq Manual (development version)」をご参照ください。

Fn::FormatTime

現在の時刻のフォーマット済み値を返します。

Fn::MarketplaceImage

イメージのプロダクトコードに基づいて、Alibaba Cloud Marketplace イメージのデフォルト ID を返します。

Fn::Any

配列内の値を確認します。いずれかの値が true と評価された場合は true が返されます。いずれの値も true と評価されない場合は false が返されます。

Fn::Contains

指定された値がリスト内の少なくとも 1 つのメンバーと一致する場合は true を返し、そうでない場合は false を返します。

Fn::EachMemberIn

リスト内の各メンバーが別のリスト内の少なくとも 1 つのメンバーと一致する場合は true を返し、そうでない場合は false を返します。

Fn::MatchPattern

文字列型の値が正規表現の条件と一致するかどうかを確認します。値が条件と一致する場合は true が返されます。そうでない場合は false が返されます。