カスタムリソースの応答オブジェクト
このトピックでは、CloudFormation カスタムリソースの応答オブジェクトのプロパティについて説明します。
カスタムリソースの概要とその仕組みについては、「」を参照してくださいカスタムリソースを使用してカスタムプロビジョニングロジックを作成する。
カスタムリソースプロバイダーの応答フィールド
以下に示すのは、カスタムリソースプロバイダーが JSON ファイルを署名付き URL に送信するときに含めるプロパティです。署名付き URL を使用したオブジェクトのアップロードについての詳細は、「Amazon Simple Storage Service ユーザーガイド」の関連するトピックを参照してください。
注記
レスポンス本文の合計サイズは 4,096 バイトを超えることはできません。
Status-
AWS CloudFormation で生成されたリクエストに応答して、カスタムリソースプロバイダーによって送信されるステータス値。
SUCCESSまたはFAILEDである必要があります。必須: はい
型: 文字列
Reason-
失敗応答の理由を説明します。
必須:
StatusがFAILEDの場合に必要です。それ以外の場合はオプションです。型: 文字列
PhysicalResourceIdこの値は、カスタムリソースベンダーに固有の識別子である必要があり、サイズは最大 1 KB までです。値は空でない文字列でなければならず、同じリソースに対するすべての応答で同一である必要があります。
PhysicalResourceIdに返された値は、カスタムリソース更新オペレーションを変更できます。返される値が同じであれば、通常の更新と見なされます。返された値が異なる場合には、AWS CloudFormation は新しい方が更新用のものであると認識し、古いリソースに削除リクエストを送信します。詳細については、「AWS::CloudFormation::CustomResource」を参照してください。必須: はい
型: 文字列
StackId-
カスタムリソースを含むスタックを識別する Amazon リソースネーム (ARN)。この応答値は、リクエストから逐語的にコピーする必要があります。
必須: はい
型: 文字列
RequestId-
リクエストの一意の ID。この応答値は、リクエストから逐語的にコピーする必要があります。
必須: はい
型: 文字列
LogicalResourceId-
AWS CloudFormation テンプレートで開発者が選択したカスタムリソースの名前 (論理 ID)。この応答値は、リクエストから逐語的にコピーする必要があります。
必須: はい
型: 文字列
NoEcho-
オプション。
Fn::GetAtt関数を使用して取得したときに、カスタムリソースの出力をマスクするかどうかを示します。trueに設定すると、テンプレートのMetadataセクションに格納されているものを除き、すべての戻り値がアスタリスク (*****) でマスクされる。AWS CloudFormation は、Metadataセクションに含まれる情報を変換、変更、または編集しません。デフォルト値はfalseです。NoEchoを使用して機密情報をマスクする方法の詳細については、「テンプレートに認証情報を埋め込まない」ベストプラクティスを参照してください。必須: いいえ
タイプ: ブール
Data-
オプション。レスポンスで送信するカスタムリソースプロバイダー定義の名前と値のペア。ここで提供されている値には、
Fn::GetAttを使用してテンプレートの名前でアクセスできます。重要
名前と値のペアに機密情報が含まれている場合は、
NoEchoフィールドを使用して、カスタムリソースの出力をマスクします。それ以外の場合は、プロパティ値 (DescribeStackEventsなど) を表示する API を通じて値が表示されます。必須: いいえ
タイプ: JSON オブジェクト
