FunctionInvoker を使用して関数を呼び出す - Resource Orchestration Service

ALIYUN::FC::FunctionInvoker は、関数を呼び出すために使用されます。

構文

{
  "Type": "ALIYUN::FC::FunctionInvoker",
  "Properties": {
    "Qualifier": String, // 修飾子
    "ServiceName": String, // サービス名
    "ExecuteVersion": Integer, // 実行バージョン
    "Async": Boolean, // 非同期
    "Event": String, // イベント
    "FunctionName": String, // 関数名
    "CheckError": Boolean, // エラーチェック
    "ServiceRegionId": String, // サービスリージョンID
    "CheckAsyncInvocation": Map // 非同期呼び出しのチェック
  }
}

プロパティ

プロパティ	型	必須	編集可能	説明	制約
ServiceName	String	はい	はい	サービスの名前。	名前は 1 ～ 128 文字である必要があります。
FunctionName	String	はい	はい	関数の名前。	なし。
Async	Boolean	いいえ	はい	非同期呼び出し機能を有効にするかどうかを指定します。	有効な値: true false (デフォルト)
Event	String	いいえ	はい	関数のカスタム入力プロパティ。	値は UTF-8 文字列としてエンコードされ、関数の実行中に関数に渡されます。バイナリ文字列または非 UTF-8 エンコード文字列として値を渡す場合は、関数に渡す前に Base64 で値をエンコードします。
Qualifier	String	いいえ	はい	サービスのバージョン。	有効な値: versionId aliasName
ExecuteVersion	Integer	いいえ	はい	呼び出される関数の識別子のバージョン。リソースの作成時にこのプロパティを指定すると、関数が呼び出されます。そうしないと、関数は呼び出されません。プロパティ値を変更し、リソースの更新時に変更された値が整数の場合、関数が呼び出されます。そうしないと、関数は呼び出されません。	なし。
CheckError	Boolean	いいえ	いいえ	呼び出し結果を確認するかどうかを指定します。	有効な値: true 説明このプロパティが true に設定されていて、呼び出しが失敗した場合、リソースの作成は失敗します。 false (デフォルト)
ServiceRegionId	String	いいえ	いいえ	関数サービスのリージョン ID。	なし。
CheckAsyncInvocation	Map	いいえ	いいえ	非同期呼び出しのチェックの構成。	詳細については、このトピックの「CheckAsyncInvocation プロパティ」をご参照ください。

CheckAsyncInvocation 構文

"CheckAsyncInvocation": {
  "Enabled": Boolean, // 有効化
  "CheckInterval": Integer, // チェック間隔
  "CheckTimes": Integer // チェック回数
}

CheckAsyncInvocation プロパティ

プロパティ	型	必須	編集可能	説明	制約
Enabled	Boolean	はい	いいえ	非同期呼び出し結果を確認するかどうかを指定します。	このプロパティと Async を true に設定すると、非同期呼び出しが完了し、非同期呼び出し結果が確認された後に、システムはリソースを作成します。デフォルト値: false。
CheckInterval	Integer	はい	いいえ	非同期呼び出し結果の 2 回の連続チェックの時間間隔。	デフォルト値: 10。単位: 秒。
CheckTimes	Integer	はい	いいえ	非同期呼び出し結果のチェック回数。	デフォルト値: 10。

戻り値

Fn::GetAtt

ResultType:
- Async が true に設定され、ResultType が NoResult に設定されている場合、結果は返されません。
- Async が false に設定され、ResultType が Success に設定されている場合、呼び出しは成功です。
- Async が false に設定され、ResultType が Failure に設定されている場合、呼び出しは失敗です。
Result:
- ResultType が NoResult に設定されている場合、Result の値は null です。
- ResultType が Success に設定されている場合、Result の値は関数呼び出し結果です。関数の実装に基づいて結果を解釈できます。返される結果は、UTF-8 エンコード文字列である必要があります。そうでない場合、関数呼び出しは失敗します。返される結果がバイナリ文字列または非 UTF-8 エンコード文字列の場合、結果は返される前に Base64 でエンコードする必要があります。
- ResultType が Failure に設定されている場合、Result にエラーメッセージが返されます。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters: {}
Resources:
  FunctionInvoker:
    Type: ALIYUN::FC::FunctionInvoker
    Properties:
      ServiceName: mytest
      FunctionName: PythonFunc
      ExecuteVersion: 1
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
  },
  "Resources": {
    "FunctionInvoker": {
      "Type": "ALIYUN::FC::FunctionInvoker",
      "Properties": {
        "ServiceName": "mytest", // サービス名
        "FunctionName": "PythonFunc", // 関数名
        "ExecuteVersion": 1.0 // 実行バージョン
      }
    }
  },
  "Outputs": {
  }
}